SR-6277 "WIP" Mute non-json output from dump-package

Submitting PR for feedback on the solution, in advance of writing unit tests.

This PR mutes tool progress output by default.

It also introduces a new dump-package option: ` --include-tool-output` to override this default and show dependency resolution and fetch progress as before.

Diagnostics that contain an error are still printed to the console.

I am seeking feedback on this solution as I an new to this codebase and unfamiliar with it's broader structure, and expectations regarding tool putput handling.

Author: erwinmaza

Sources/Commands/Options.swift

@@ -31,6 +31,9 @@ public class ToolOptions {
     /// Enable prefetching in resolver which will kick off parallel git cloning.
     public var shouldEnableResolverPrefetching = true
 
+    /// Mute the output of tool operations.
+    public var shouldMuteOutput = true
+
     /// If print version option was passed.
     public var shouldPrintVersion: Bool = false
 

Sources/Commands/SwiftPackageTool.swift

@@ -175,6 +175,8 @@ public class SwiftPackageTool: SwiftTool<PackageToolOptions> {
             describe(graph.rootPackages[0].underlyingPackage, in: options.describeMode, on: stdoutStream)
 
         case .dumpPackage:
+            options.shouldMuteOutput = !options.dumpPackageOptions.includeToolOutput
+
             let graph = try loadPackageGraph()
             let manifest = graph.rootPackages[0].manifest
             print(try manifest.jsonString())
@@ -212,7 +214,10 @@ public class SwiftPackageTool: SwiftTool<PackageToolOptions> {
             option: describeParser.add(option: "--type", kind: DescribeMode.self, usage: "json|text"),
             to: { $0.describeMode = $1 })
 
-        _ = parser.add(subparser: PackageMode.dumpPackage.rawValue, overview: "Print parsed Package.swift as JSON")
+        let dumpParser = parser.add(subparser: PackageMode.dumpPackage.rawValue, overview: "Print parsed Package.swift as JSON")
+        binder.bind(
+            option: dumpParser.add(option: "--include-tool-output", kind: Bool.self, usage: "Show package manager output"),
+            to: { $0.dumpPackageOptions.includeToolOutput = $1 })
 
         let editParser = parser.add(subparser: PackageMode.edit.rawValue, overview: "Put a package in editable mode")
         binder.bind(
@@ -371,6 +376,12 @@ public class PackageToolOptions: ToolOptions {
     var inputPath: AbsolutePath?
     var showDepsMode: ShowDependenciesMode = .text
 
+	struct DumpPackageOptions {
+		var includeToolOutput = false
+	}
+
+	var dumpPackageOptions = DumpPackageOptions()
+
     struct EditOptions {
         var packageName: String?
         var revision: String?

Sources/Commands/SwiftTool.swift

@@ -69,6 +69,12 @@ struct TargetNotFoundDiagnostic: DiagnosticData {
 
 private class ToolWorkspaceDelegate: WorkspaceDelegate {
 
+    private let options: ToolOptions
+
+    init(toolOptions: ToolOptions) {
+        options = toolOptions
+    }
+
     func packageGraphWillLoad(
         currentGraph: PackageGraph,
         dependencies: AnySequence<ManagedDependency>,
@@ -77,39 +83,53 @@ private class ToolWorkspaceDelegate: WorkspaceDelegate {
     }
 
     func fetchingWillBegin(repository: String) {
-        print("Fetching \(repository)")
+        if !options.shouldMuteOutput {
+            print("Fetching \(repository)")
+        }
     }
 
     func fetchingDidFinish(repository: String, diagnostic: Diagnostic?) {
     }
 
     func repositoryWillUpdate(_ repository: String) {
-        print("Updating \(repository)")
+        if !options.shouldMuteOutput {
+            print("Updating \(repository)")
+        }
     }
 
     func repositoryDidUpdate(_ repository: String) {
     }
 
     func dependenciesUpToDate() {
-        print("Everything is already up-to-date")
+        if !options.shouldMuteOutput {
+            print("Everything is already up-to-date")
+        }
     }
 
     func cloning(repository: String) {
-        print("Cloning \(repository)")
+        if !options.shouldMuteOutput {
+            print("Cloning \(repository)")
+        }
     }
 
     func checkingOut(repository: String, atReference reference: String, to path: AbsolutePath) {
         // FIXME: This is temporary output similar to old one, we will need to figure
         // out better reporting text.
-        print("Resolving \(repository) at \(reference)")
+        if !options.shouldMuteOutput {
+            print("Resolving \(repository) at \(reference)")
+        }
     }
 
     func removing(repository: String) {
-        print("Removing \(repository)")
+        if !options.shouldMuteOutput {
+            print("Removing \(repository)")
+        }
     }
 
     func warning(message: String) {
-        print("warning: " + message)
+        if !options.shouldMuteOutput {
+            print("warning: " + message)
+        }
     }
 
     func managedDependenciesDidUpdate(_ dependencies: AnySequence<ManagedDependency>) {
@@ -202,7 +222,7 @@ public class SwiftTool<Options: ToolOptions> {
     let interruptHandler: InterruptHandler
 
     /// The diagnostics engine.
-    let diagnostics = DiagnosticsEngine(handlers: [SwiftTool.diagnosticsHandler])
+	let diagnostics: DiagnosticsEngine
 
     /// The execution status of the tool.
     var executionStatus: ExecutionStatus = .success
@@ -325,8 +345,9 @@ public class SwiftTool<Options: ToolOptions> {
 
             var options = Options()
             try binder.fill(parseResult: result, into: &options)
-
+            diagnostics = DiagnosticsEngine(handlers: [setupDiagnosticsHandler(with: options)])
             self.options = options
+
             // Honor package-path option is provided.
             if let packagePath = options.packagePath ?? options.chdir {
                 // FIXME: This should be an API which takes AbsolutePath and maybe
@@ -368,7 +389,7 @@ public class SwiftTool<Options: ToolOptions> {
         self.buildPath = getEnvBuildPath() ??
             customBuildPath ??
             (packageRoot ?? localFileSystem.currentWorkingDirectory!).appending(component: ".build")
-        
+
         if options.chdir != nil {
             diagnostics.emit(data: ChdirDeprecatedDiagnostic())
         }
@@ -394,7 +415,8 @@ public class SwiftTool<Options: ToolOptions> {
         if let workspace = _workspace {
             return workspace
         }
-        let delegate = ToolWorkspaceDelegate()
+        let delegate = ToolWorkspaceDelegate(toolOptions: options)
+
         let rootPackage = try getPackageRoot()
         let provider = GitRepositoryProvider(processSet: processSet)
         let workspace = Workspace(
@@ -431,10 +453,6 @@ public class SwiftTool<Options: ToolOptions> {
         SwiftTool.exit(with: executionStatus)
     }
 
-    static func diagnosticsHandler(_ diagnostic: Diagnostic) {
-        print(diagnostic: diagnostic)
-    }
-
     /// Exit the tool with the given execution status.
     private static func exit(with status: ExecutionStatus) -> Never {
         switch status {
@@ -680,6 +698,14 @@ public class SwiftTool<Options: ToolOptions> {
     }
 }
 
+func setupDiagnosticsHandler(with options: ToolOptions) -> (Diagnostic) -> Void {
+    return { diagnostic in
+        if !options.shouldMuteOutput || diagnostic.behavior == .error {
+            print(diagnostic: diagnostic)
+        }
+    }
+}
+
 /// An enum representing what subset of the package to build.
 enum BuildSubset {
     /// Represents the subset of all products and non-test targets.