Add module-name parameter to make DocC integration more flexible

Author: ayushshrivastv

Sources/CLI/main.swift

@@ -17,6 +17,9 @@ struct OpenAPIToSymbolGraph: ParsableCommand {
     @Option(name: .long, help: "Path where the symbol graph file should be written", transform: { $0 })
     var outputPath: String = "openapi.symbolgraph.json"
 
+    @Option(name: .long, help: "Name to use for the module in the symbol graph", transform: { $0 })
+    var moduleName: String?
+    
     mutating func run() throws {
         // Check file extension
         let fileExtension = URL(fileURLWithPath: inputPath).pathExtension.lowercased()
@@ -37,7 +40,7 @@ struct OpenAPIToSymbolGraph: ParsableCommand {
             let document = try parser.parse(fileContent)
 
             // Convert to symbol graph
-            let converter = Integration.OpenAPIDocCConverter()
+            let converter = Integration.OpenAPIDocCConverter(moduleName: moduleName)
             let symbolGraph = converter.convert(document)
 
             // Write the symbol graph to file

Sources/DocC/Generators/SymbolGraphGenerator.swift

@@ -4,8 +4,13 @@ import SymbolKit
 
 /// A generator that converts OpenAPI documents to DocC symbol graphs
 public struct SymbolGraphGenerator {
+    /// The name to use for the module
+    public var moduleName: String?
+    
     /// Creates a new symbol graph generator
-    public init() {}
+    public init(moduleName: String? = nil) {
+        self.moduleName = moduleName
+    }
 
     /// Generates a symbol graph from an OpenAPI document
     /// - Parameter document: The OpenAPI document to convert
@@ -106,14 +111,15 @@ public struct SymbolGraphGenerator {
     }
 
     private func createModuleSymbol(from info: Info) -> SymbolKit.SymbolGraph.Symbol {
+        let moduleName = self.moduleName ?? info.title
         let identifier = SymbolKit.SymbolGraph.Symbol.Identifier(
             precise: "module",
             interfaceLanguage: "openapi"
         )
 
         let names = SymbolKit.SymbolGraph.Symbol.Names(
-            title: info.title,
-            navigator: [.init(kind: .text, spelling: info.title, preciseIdentifier: nil)],
+            title: moduleName,
+            navigator: [.init(kind: .text, spelling: moduleName, preciseIdentifier: nil)],
             subHeading: nil,
             prose: nil
         )
@@ -128,7 +134,7 @@ public struct SymbolGraphGenerator {
         return SymbolKit.SymbolGraph.Symbol(
             identifier: identifier,
             names: names,
-            pathComponents: [info.title],
+            pathComponents: [moduleName],
             docComment: docComment,
             accessLevel: SymbolKit.SymbolGraph.Symbol.AccessControl(rawValue: "public"),
             kind: .init(parsedIdentifier: .module, displayName: "Module"),
@@ -292,7 +298,7 @@ public struct SymbolGraphGenerator {
 
     private func createModule(from info: Info) -> SymbolKit.SymbolGraph.Module {
         return SymbolKit.SymbolGraph.Module(
-            name: info.title,
+            name: self.moduleName ?? info.title,
             platform: SymbolKit.SymbolGraph.Platform(
                 architecture: nil,
                 vendor: "OpenAPI",

Sources/Integration/OpenAPIDocCConverter.swift

@@ -5,14 +5,19 @@ import SymbolKit
 
 /// A converter that converts OpenAPI documents to DocC symbol graphs
 public struct OpenAPIDocCConverter {
+    /// The name to use for the module
+    private let moduleName: String?
+    
     /// Creates a new OpenAPI to DocC converter
-    public init() {}
+    public init(moduleName: String? = nil) {
+        self.moduleName = moduleName
+    }
 
     /// Converts an OpenAPI document to a DocC symbol graph
     /// - Parameter document: The OpenAPI document to convert
     /// - Returns: The DocC symbol graph
     public func convert(_ document: Document) -> SymbolKit.SymbolGraph {
-        let generator = SymbolGraphGenerator()
+        let generator = SymbolGraphGenerator(moduleName: moduleName)
         return generator.generate(from: document)
     }
 }

scripts/build-docs.sh

@@ -6,7 +6,7 @@ mkdir -p docs
 
 # Convert OpenAPI specification to symbol graph
 echo "Converting OpenAPI spec to SymbolGraph..."
-swift run openapi-to-symbolgraph registry.openapi.yaml --output-path registry.symbolgraph.json
+swift run openapi-to-symbolgraph registry.openapi.yaml --output-path registry.symbolgraph.json --module-name "RegistryAPI"
 
 # Generate DocC documentation
 echo "Generating DocC documentation..."