rename feature flag

Author: Jesse Haigh

Sources/SwiftDocC/Infrastructure/Workspace/FeatureFlags+Info.swift

@@ -37,11 +37,11 @@ extension DocumentationBundle.Info {
             self.unknownFeatureFlags = []
         }
 
-        /// This feature flag corresponds to ``FeatureFlags/isExperimentalCodeBlockEnabled``.
-        public var experimentalCodeBlock: Bool?
+        /// This feature flag corresponds to ``FeatureFlags/isExperimentalCodeBlockAnnotationsEnabled``.
+        public var experimentalCodeBlockAnnotations: Bool?
 
-        public init(experimentalCodeBlock: Bool? = nil) {
-            self.experimentalCodeBlock = experimentalCodeBlock
+        public init(experimentalCodeBlockAnnotations: Bool? = nil) {
+            self.experimentalCodeBlockAnnotations = experimentalCodeBlockAnnotations
             self.unknownFeatureFlags = []
         }
 
@@ -50,7 +50,7 @@ extension DocumentationBundle.Info {
 
         enum CodingKeys: String, CodingKey, CaseIterable {
             case experimentalOverloadedSymbolPresentation = "ExperimentalOverloadedSymbolPresentation"
-            case experimentalCodeBlock = "ExperimentalCodeBlock"
+            case experimentalCodeBlockAnnotations = "ExperimentalCodeBlockAnnotations"
         }
 
         struct AnyCodingKeys: CodingKey {
@@ -76,8 +76,8 @@ extension DocumentationBundle.Info {
                     case .experimentalOverloadedSymbolPresentation:
                         self.experimentalOverloadedSymbolPresentation = try values.decode(Bool.self, forKey: flagName)
 
-                    case .experimentalCodeBlock:
-                        self.experimentalCodeBlock = try values.decode(Bool.self, forKey: flagName)
+                    case .experimentalCodeBlockAnnotations:
+                        self.experimentalCodeBlockAnnotations = try values.decode(Bool.self, forKey: flagName)
                     }
                 } else {
                     unknownFeatureFlags.append(flagName.stringValue)
@@ -91,7 +91,7 @@ extension DocumentationBundle.Info {
             var container = encoder.container(keyedBy: CodingKeys.self)
 
             try container.encode(experimentalOverloadedSymbolPresentation, forKey: .experimentalOverloadedSymbolPresentation)
-            try container.encode(experimentalCodeBlock, forKey: .experimentalCodeBlock)
+            try container.encode(experimentalCodeBlockAnnotations, forKey: .experimentalCodeBlockAnnotations)
         }
     }
 }

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

@@ -733,7 +733,7 @@ extension RenderBlockContent: Codable {
             }
             self = try .aside(.init(style: style, content: container.decode([RenderBlockContent].self, forKey: .content)))
         case .codeListing:
-            let copy = FeatureFlags.current.isExperimentalCodeBlockEnabled
+            let copy = FeatureFlags.current.isExperimentalCodeBlockAnnotationsEnabled
             self = try .codeListing(.init(
                 syntax: container.decodeIfPresent(String.self, forKey: .syntax),
                 code: container.decode([String].self, forKey: .code),

Sources/SwiftDocC/Model/Rendering/RenderContentCompiler.swift

@@ -48,7 +48,7 @@ struct RenderContentCompiler: MarkupVisitor {
     mutating func visitCodeBlock(_ codeBlock: CodeBlock) -> [any RenderContent] {
         // Default to the bundle's code listing syntax if one is not explicitly declared in the code block.
 
-        if FeatureFlags.current.isExperimentalCodeBlockEnabled {
+        if FeatureFlags.current.isExperimentalCodeBlockAnnotationsEnabled {
 
             func parseLanguageString(_ input: String?) -> (lang: String? , tokens: [RenderBlockContent.CodeListing.OptionName]) {
                 guard let input else { return (lang: nil, tokens: []) }

Sources/SwiftDocC/Semantics/Snippets/Snippet.swift

@@ -83,12 +83,12 @@ extension Snippet: RenderableDirectiveConvertible {
                 let lines = snippetMixin.lines[lineRange]
                 let minimumIndentation = lines.map { $0.prefix { $0.isWhitespace }.count }.min() ?? 0
                 let trimmedLines = lines.map { String($0.dropFirst(minimumIndentation)) }
-                let copy = FeatureFlags.current.isExperimentalCodeBlockEnabled
+                let copy = FeatureFlags.current.isExperimentalCodeBlockAnnotationsEnabled
                 return [RenderBlockContent.codeListing(.init(syntax: snippetMixin.language, code: trimmedLines, metadata: nil, copyToClipboard: copy))]
             } else {
                 // Render the whole snippet with its explanation content.
                 let docCommentContent = snippetEntity.markup.children.flatMap { contentCompiler.visit($0) }
-                let copy = FeatureFlags.current.isExperimentalCodeBlockEnabled
+                let copy = FeatureFlags.current.isExperimentalCodeBlockAnnotationsEnabled
                 let code = RenderBlockContent.codeListing(.init(syntax: snippetMixin.language, code: snippetMixin.lines, metadata: nil, copyToClipboard: copy))
                 return docCommentContent + [code]
             }

Sources/SwiftDocC/Utility/FeatureFlags.swift

@@ -15,7 +15,7 @@ public struct FeatureFlags: Codable {
     public static var current = FeatureFlags()
 
     /// Whether or not experimental annotation of code blocks is enabled.
-    public var isExperimentalCodeBlockEnabled = false
+    public var isExperimentalCodeBlockAnnotationsEnabled = false
 
     /// Whether or not experimental support for device frames on images and video is enabled.
     public var isExperimentalDeviceFrameSupportEnabled = false

Sources/SwiftDocCUtilities/ArgumentParsing/ActionExtensions/ConvertAction+CommandInitialization.swift

@@ -19,7 +19,7 @@ extension ConvertAction {
     public init(fromConvertCommand convert: Docc.Convert, withFallbackTemplate fallbackTemplateURL: URL? = nil) throws {
         var standardError = LogHandle.standardError
         let outOfProcessResolver: OutOfProcessReferenceResolver?
-        FeatureFlags.current.isExperimentalCodeBlockEnabled = convert.enableExperimentalCodeBlock
+        FeatureFlags.current.isExperimentalCodeBlockAnnotationsEnabled = convert.featureFlags.enableExperimentalCodeBlockAnnotations
         FeatureFlags.current.isExperimentalDeviceFrameSupportEnabled = convert.enableExperimentalDeviceFrameSupport
         FeatureFlags.current.isExperimentalLinkHierarchySerializationEnabled = convert.enableExperimentalLinkHierarchySerialization
         FeatureFlags.current.isExperimentalOverloadedSymbolPresentationEnabled = convert.enableExperimentalOverloadedSymbolPresentation

Sources/SwiftDocCUtilities/ArgumentParsing/Subcommands/Convert.swift

@@ -477,10 +477,10 @@ extension Docc {
             var experimentalEnableCustomTemplates = false
 
             @Flag(
-                name: .customLong("enable-experimental-code-block"),
-                help: "Support copy-to-clipboard for code blocks."
+                name: .customLong("enable-experimental-code-block-annotations"),
+                help: "Support annotations for code blocks."
             )
-            var enableExperimentalCodeBlock = false
+            var enableExperimentalCodeBlockAnnotations = false
 
             @Flag(help: .hidden)
             var enableExperimentalDeviceFrameSupport = false
@@ -567,9 +567,9 @@ extension Docc {
         /// A user-provided value that is true if the user enables experimental support for code block annotation.
         ///
         /// Defaults to false.
-        public var enableExperimentalCodeBlock: Bool {
-            get { featureFlags.enableExperimentalCodeBlock }
-            set { featureFlags.enableExperimentalCodeBlock = newValue}
+        public var enableExperimentalCodeBlocAnnotations: Bool {
+            get { featureFlags.enableExperimentalCodeBlockAnnotations }
+            set { featureFlags.enableExperimentalCodeBlockAnnotations = newValue}
         }
 
         /// A user-provided value that is true if the user enables experimental support for device frames.

Tests/SwiftDocCTests/Rendering/RenderContentCompilerTests.swift

@@ -225,7 +225,7 @@ class RenderContentCompilerTests: XCTestCase {
     }
 
     func testCopyToClipboard() async throws {
-        enableFeatureFlag(\.isExperimentalCodeBlockEnabled)
+        enableFeatureFlag(\.isExperimentalCodeBlockAnnotationsEnabled)
 
         let (bundle, context) = try await testBundleAndContext()
         var compiler = RenderContentCompiler(context: context, bundle: bundle, identifier: ResolvedTopicReference(bundleID: bundle.id, path: "/path", fragment: nil, sourceLanguage: .swift))
@@ -249,7 +249,7 @@ class RenderContentCompilerTests: XCTestCase {
     }
 
     func testNoCopyToClipboard() async throws {
-        enableFeatureFlag(\.isExperimentalCodeBlockEnabled)
+        enableFeatureFlag(\.isExperimentalCodeBlockAnnotationsEnabled)
 
         let (bundle, context) = try await testBundleAndContext()
         var compiler = RenderContentCompiler(context: context, bundle: bundle, identifier: ResolvedTopicReference(bundleID: bundle.id, path: "/path", fragment: nil, sourceLanguage: .swift))