Fixes based on feedback:

- change output format to an enumeration
- change verbosity to log level to avoid using the global

Author: abertelrud

Sources/Commands/SwiftPackageTool.swift

@@ -564,8 +564,7 @@ extension SwiftPackageTool {
                 skipSynthesizedMembers: skipSynthesizedMembers,
                 minimumAccessLevel: minimumAccessLevel,
                 skipInheritedDocs: skipInheritedDocs,
-                includeSPISymbols: includeSPISymbols,
-                prettyPrintOutputJSON: prettyPrint)
+                includeSPISymbols: includeSPISymbols)
 
             // Run the tool once for every library and executable target in the root package.
             let buildPlan = buildOp.buildPlan!
@@ -576,7 +575,7 @@ extension SwiftPackageTool {
                 try symbolGraphExtractor.extractSymbolGraph(
                     target: target,
                     buildPlan: buildPlan,
-                    verbose: verbosity != .concise,
+                    logLevel: swiftTool.logLevel,
                     outputDirectory: symbolGraphDirectory)
             }
 
@@ -1276,7 +1275,7 @@ final class PluginDelegate: PluginInvocationDelegate {
             target: target,
             buildPlan: buildPlan,
             outputRedirection: .collect,
-            verbose: false,
+            logLevel: .warning,
             outputDirectory: outputDir)
 
         // Return the results to the plugin.

Sources/Commands/SymbolGraphExtract.swift

@@ -9,6 +9,7 @@
 */
 
 import ArgumentParser
+import Basics
 import Build
 import PackageGraph
 import PackageModel
@@ -19,26 +20,31 @@ import TSCUtility
 /// A wrapper for swift-symbolgraph-extract tool.
 public struct SymbolGraphExtract {
     let tool: AbsolutePath
-    var skipSynthesizedMembers: Bool = false
-    var minimumAccessLevel: AccessLevel = .public
-    var skipInheritedDocs: Bool = false
-    var includeSPISymbols: Bool = false
-    var prettyPrintOutputJSON: Bool = false
+    
+    var skipSynthesizedMembers = false
+    var minimumAccessLevel = AccessLevel.public
+    var skipInheritedDocs = false
+    var includeSPISymbols = false
+    var outputFormat = OutputFormat.json(pretty: false)
 
     /// Access control levels.
-    public enum AccessLevel: String, RawRepresentable, CustomStringConvertible, CaseIterable, ExpressibleByArgument {
+    public enum AccessLevel: String, RawRepresentable, CaseIterable, ExpressibleByArgument {
         // 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 }
     }
 
+    /// Output format of the generated symbol graph.
+    public enum OutputFormat {
+        /// JSON format, optionally "pretty-printed" be more human-readable.
+        case json(pretty: Bool)
+    }
+    
     /// Creates a symbol graph for `target` in `outputDirectory` using the build information from `buildPlan`. The `outputDirection` determines how the output from the tool subprocess is handled, and `verbosity` specifies how much console output to ask the tool to emit.
     public func extractSymbolGraph(
         target: ResolvedTarget,
         buildPlan: BuildPlan,
         outputRedirection: Process.OutputRedirection = .none,
-        verbose: Bool,
+        logLevel: Basics.Diagnostic.Severity,
         outputDirectory: AbsolutePath
     ) throws {
         let buildParameters = buildPlan.buildParameters
@@ -50,7 +56,7 @@ public struct SymbolGraphExtract {
         commandLine += try buildParameters.targetTripleArgs(for: target)
         commandLine += buildPlan.createAPIToolCommonArgs(includeLibrarySearchPaths: true)
         commandLine += ["-module-cache-path", buildParameters.moduleCache.pathString]
-        if verbose {
+        if logLevel <= .info {
             commandLine += ["-v"]
         }
         commandLine += ["-minimum-access-level", minimumAccessLevel.rawValue]
@@ -63,16 +69,19 @@ public struct SymbolGraphExtract {
         if includeSPISymbols {
             commandLine += ["-include-spi-symbols"]
         }
-        if prettyPrintOutputJSON {
-            commandLine += ["-pretty-print"]
+        switch outputFormat {
+        case .json(let pretty):
+            if pretty {
+                commandLine += ["-pretty-print"]
+            }
         }
         commandLine += ["-output-dir", outputDirectory.pathString]
 
         // Run the extraction.
         let process = Process(
             arguments: commandLine,
             outputRedirection: outputRedirection,
-            verbose: verbose)
+            verbose: logLevel <= .info)
         try process.launch()
         try process.waitUntilExit()
     }

Tests/CommandsTests/PackageToolTests.swift

@@ -1508,18 +1508,20 @@ final class PackageToolTests: CommandsTestCase {
             // Check that if we don't pass any target, we successfully get symbol graph information for all targets in the package, and at different paths.
             do {
                 let result = try SwiftPMProduct.SwiftPackage.executeProcess(["generate-documentation"], packagePath: packageDir)
-                XCTAssertEqual(result.exitStatus, .terminated(code: 0))
-                XCTAssertMatch(try result.utf8Output(), .and(.contains("MyLibrary:"), .contains("mypackage/MyLibrary")))
-                XCTAssertMatch(try result.utf8Output(), .and(.contains("MyCommand:"), .contains("mypackage/MyCommand")))
+                let output = try result.utf8Output() + result.utf8stderrOutput()
+                XCTAssertEqual(result.exitStatus, .terminated(code: 0), "output: \(output)")
+                XCTAssertMatch(output, .and(.contains("MyLibrary:"), .contains("mypackage/MyLibrary")))
+                XCTAssertMatch(output, .and(.contains("MyCommand:"), .contains("mypackage/MyCommand")))
 
             }
 
             // Check that if we pass a target, we successfully get symbol graph information for just the target we asked for.
             do {
                 let result = try SwiftPMProduct.SwiftPackage.executeProcess(["--target", "MyLibrary", "generate-documentation"], packagePath: packageDir)
-                XCTAssertEqual(result.exitStatus, .terminated(code: 0))
-                XCTAssertMatch(try result.utf8Output(), .and(.contains("MyLibrary:"), .contains("mypackage/MyLibrary")))
-                XCTAssertNoMatch(try result.utf8Output(), .and(.contains("MyCommand:"), .contains("mypackage/MyCommand")))
+                let output = try result.utf8Output() + result.utf8stderrOutput()
+                XCTAssertEqual(result.exitStatus, .terminated(code: 0), "output: \(output)")
+                XCTAssertMatch(output, .and(.contains("MyLibrary:"), .contains("mypackage/MyLibrary")))
+                XCTAssertNoMatch(output, .and(.contains("MyCommand:"), .contains("mypackage/MyCommand")))
             }
         }
     }