Pass symbolgraph flags to symbolgraph-extract (#3682)

Passes flags from `swift package dump-symbol-graph` to `swift-symbolgraph-extract`

The following flags are added: `prettyPrint`, `skipSynthesisedMembers`, `minimumAccessLevel`, `skipInheritedDocs` and `includeSPISymbols`.

Author: Dev1an

Sources/Commands/SwiftPackageTool.swift

@@ -493,10 +493,26 @@ extension SwiftPackageTool {
     struct DumpSymbolGraph: SwiftCommand {
         static let configuration = CommandConfiguration(
             abstract: "Dump Symbol Graph")
+        static let defaultMinimumAccessLevel = AccessLevel.public
 
         @OptionGroup(_hiddenFromHelp: true)
         var swiftOptions: SwiftToolOptions
-        
+
+        @Flag(help: "Pretty-print the output JSON.")
+        var prettyPrint = false
+
+        @Flag(help: "Skip members inherited through classes or default implementations.")
+        var skipSynthesizedMembers = false
+
+        @Option(help: "Include symbols with this access level or more. Possible values: \(AccessLevel.allValueStrings.joined(separator: " | "))")
+        var minimumAccessLevel = defaultMinimumAccessLevel
+
+        @Flag(help: "Skip emitting doc comments for members inherited through classes or default implementations.")
+        var skipInheritedDocs = false
+
+        @Flag(help: "Add symbols with SPI information to the symbol graph.")
+        var includeSPISymbols = false
+
         func run(_ swiftTool: SwiftTool) throws {
             let symbolGraphExtract = try SymbolGraphExtract(
                 tool: swiftTool.getToolchain().getSymbolGraphExtract())
@@ -508,7 +524,12 @@ extension SwiftPackageTool {
             try buildOp.build()
 
             try symbolGraphExtract.dumpSymbolGraph(
-                buildPlan: buildOp.buildPlan!
+                buildPlan: buildOp.buildPlan!,
+                prettyPrint: prettyPrint,
+                skipSynthesisedMembers: skipSynthesizedMembers,
+                minimumAccessLevel: minimumAccessLevel,
+                skipInheritedDocs: skipInheritedDocs,
+                includeSPISymbols: includeSPISymbols
             )
         }
     }

Sources/Commands/SymbolGraphExtract.swift

@@ -19,6 +19,7 @@ import PackageGraph
 import PackageModel
 import SourceControl
 import Workspace
+import ArgumentParser
 
 /// A wrapper for swift-symbolgraph-extract tool.
 public struct SymbolGraphExtract {
@@ -29,7 +30,12 @@ public struct SymbolGraphExtract {
     }
 
     public func dumpSymbolGraph(
-        buildPlan: BuildPlan
+        buildPlan: BuildPlan,
+        prettyPrint: Bool,
+        skipSynthesisedMembers: Bool,
+        minimumAccessLevel: AccessLevel,
+        skipInheritedDocs: Bool,
+        includeSPISymbols: Bool
     ) throws {
         let buildParameters = buildPlan.buildParameters
         let symbolGraphDirectory = buildPlan.buildParameters.symbolGraph
@@ -47,6 +53,14 @@ public struct SymbolGraphExtract {
 
             args += ["-output-dir", symbolGraphDirectory.pathString]
 
+            if prettyPrint { args.append("-pretty-print") }
+            if skipSynthesisedMembers { args.append("-skip-synthesized-members") }
+            if minimumAccessLevel != SwiftPackageTool.DumpSymbolGraph.defaultMinimumAccessLevel {
+                args += ["-minimum-access-level", minimumAccessLevel.rawValue]
+            }
+            if skipInheritedDocs { args.append("-skip-inherited-docs") }
+            if includeSPISymbols { args.append("-include-spi-symbols") }
+
             print("-- Emitting symbol graph for", target.name)
             try runTool(args)
         }
@@ -65,6 +79,16 @@ public struct SymbolGraphExtract {
     }
 }
 
+/// Access control levels.
+public enum AccessLevel: String, RawRepresentable, CustomStringConvertible, CaseIterable {
+    // The cases reflect those found in `include/swift/AST/AttrKind.h` of the swift compiler (at commit 03f55d7bb4204ca54841218eb7cc175ae798e3bd)
+    case `private`, `fileprivate`, `internal`, `public`, `open`
+
+    public var description: String { rawValue }
+}
+
+extension AccessLevel: ExpressibleByArgument {}
+
 extension BuildParameters {
     /// The directory containing artifacts generated by the symbolgraph-extract tool.
     var symbolGraph: AbsolutePath {