add code block options onto RenderBlockContent.CodeListing

Author: Jesse Haigh

Sources/SwiftDocC/Checker/Checkers/InvalidCodeBlockOption.swift

@@ -18,9 +18,8 @@ public import Markdown
 public struct InvalidCodeBlockOption: Checker {
     public var problems = [Problem]()
 
-    // FIXME: populate this from the parse options
     /// Parsing options for code blocks
-    private let knownOptions = ["nocopy"]
+    private let knownOptions = RenderBlockContent.CodeListing.knownOptions
 
     private var sourceFile: URL?
 
@@ -56,7 +55,6 @@ public struct InvalidCodeBlockOption: Checker {
                         replacements: []
                     )
                 }
-                // FIXME: figure out the position of 'token' and provide solutions
                 problems.append(Problem(diagnostic: diagnostic, possibleSolutions: possibleSolutions))
             }
         }

Sources/SwiftDocC/Model/Rendering/Content/RenderBlockContent.swift

@@ -126,6 +126,18 @@ public enum RenderBlockContent: Equatable {
         public var metadata: RenderContentMetadata?
         public var copyToClipboard: Bool = true
 
+        public enum OptionName: String, CaseIterable {
+            case nocopy
+
+            init?<S: StringProtocol>(caseInsensitive raw: S) {
+                self.init(rawValue: raw.lowercased())
+            }
+        }
+
+        public static var knownOptions: Set<String> {
+            Set(OptionName.allCases.map(\.rawValue))
+        }
+
         /// Make a new `CodeListing` with the given data.
         public init(syntax: String?, code: [String], metadata: RenderContentMetadata?, copyToClipboard: Bool) {
             self.syntax = syntax

Sources/SwiftDocC/Model/Rendering/RenderContentCompiler.swift

@@ -50,34 +50,42 @@ struct RenderContentCompiler: MarkupVisitor {
 
         if FeatureFlags.current.isExperimentalCodeBlockEnabled {
 
-            struct ParsedOptions {
-                var lang: String?
-                var nocopy = false
-            }
-
-            func parseLanguageString(_ input: String?) -> ParsedOptions {
-                guard let input else { return ParsedOptions() }
-
+            func parseLanguageString(_ input: String?) -> (lang: String? , tokens: [RenderBlockContent.CodeListing.OptionName]) {
+                guard let input else { return (lang: nil, tokens: []) }
                 let parts = input
                     .split(separator: ",")
                     .map { $0.trimmingCharacters(in: .whitespaces) }
-
-                var options = ParsedOptions()
+                var lang: String? = nil
+                var options: [RenderBlockContent.CodeListing.OptionName] = []
 
                 for part in parts {
-                    let lower = part.lowercased()
-                    if lower == "nocopy" {
-                        options.nocopy = true
-                    } else if options.lang == nil {
-                        options.lang = part
+                    if let opt = RenderBlockContent.CodeListing.OptionName(caseInsensitive: part) {
+                        options.append(opt)
+                    } else if lang == nil {
+                        lang = String(part)
                     }
                 }
-                return options
+                return (lang, options)
             }
 
             let options = parseLanguageString(codeBlock.language)
 
-            return [RenderBlockContent.codeListing(.init(syntax: options.lang ?? bundle.info.defaultCodeListingLanguage, code: codeBlock.code.splitByNewlines, metadata: nil, copyToClipboard: !options.nocopy))]
+            var listing = RenderBlockContent.CodeListing(
+                syntax: options.lang ?? bundle.info.defaultCodeListingLanguage,
+                code: codeBlock.code.splitByNewlines,
+                metadata: nil,
+                copyToClipboard: true // default value
+            )
+
+            // apply code block options
+            for option in options.tokens {
+                switch option {
+                case .nocopy:
+                    listing.copyToClipboard = false
+                }
+            }
+
+            return [RenderBlockContent.codeListing(listing)]
 
         } else {
             return [RenderBlockContent.codeListing(.init(syntax: codeBlock.language ?? bundle.info.defaultCodeListingLanguage, code: codeBlock.code.splitByNewlines, metadata: nil, copyToClipboard: false))]

Tests/SwiftDocCTests/Checker/Checkers/InvalidCodeBlockOptionTests.swift

@@ -14,6 +14,19 @@ import Markdown
 
 class InvalidCodeBlockOptionTests: XCTestCase {
 
+    func testNoOptions() {
+        let markupSource = """
+```
+let a = 1
+```
+"""
+        let document = Document(parsing: markupSource, options: [])
+        var checker = InvalidCodeBlockOption(sourceFile: nil)
+        checker.visit(document)
+        XCTAssertTrue(checker.problems.isEmpty)
+        XCTAssertEqual(RenderBlockContent.CodeListing.knownOptions, ["nocopy"])
+    }
+
     func testOption() {
         let markupSource = """
 ```nocopy