Bring back "Refactor Commands module" (#5864)

This reverts commit cf19c64 and restores the `--build-path` option. It also switches the `bootstrap` script back to using it so that we have an easy check that the option is still present.

Author: neonichu

Package.swift

@@ -342,13 +342,28 @@ let package = Package(
 
         // MARK: Commands
 
+        .target(
+            /** Minimal set of commands required for bootstrapping a new SwiftPM */
+            name: "CoreCommands",
+            dependencies: [
+                .product(name: "ArgumentParser", package: "swift-argument-parser"),
+                "Basics",
+                "Build",
+                "PackageFingerprint",
+                "PackageModel",
+                "Workspace",
+            ],
+            exclude: ["CMakeLists.txt"]
+        ),
+
         .target(
             /** High-level commands */
             name: "Commands",
             dependencies: [
                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
                 "Basics",
                 "Build",
+                "CoreCommands",
                 "PackageCollections",
                 "PackageFingerprint",
                 "PackageGraph",

Sources/CMakeLists.txt

@@ -10,6 +10,7 @@ add_subdirectory(SPMSQLite3)
 add_subdirectory(Basics)
 add_subdirectory(Build)
 add_subdirectory(Commands)
+add_subdirectory(CoreCommands)
 add_subdirectory(DriverSupport)
 add_subdirectory(LLBuildManifest)
 add_subdirectory(PackageCollections)

Sources/Commands/CMakeLists.txt

@@ -7,7 +7,6 @@
 # See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 
 add_library(Commands
-  Options.swift
   Snippets/CardEvent.swift
   Snippets/Cards/SnippetCard.swift
   Snippets/Cards/SnippetGroupCard.swift
@@ -21,7 +20,7 @@ add_library(Commands
   SwiftPackageTool.swift
   SwiftRunTool.swift
   SwiftTestTool.swift
-  SwiftTool.swift
+  ToolWorkspaceDelegate.swift
   Utilities/APIDigester.swift
   Utilities/DependenciesSerializer.swift
   Utilities/Describe.swift
@@ -35,6 +34,7 @@ target_link_libraries(Commands PUBLIC
   ArgumentParser
   Basics
   Build
+  CoreCommands
   PackageCollections
   PackageFingerprint
   PackageGraph

Sources/Commands/Snippets/CardStack.swift

@@ -11,6 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import Basics
+import CoreCommands
 import PackageGraph
 import PackageModel
 import TSCBasic

Sources/Commands/Snippets/Cards/SnippetCard.swift

@@ -10,6 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
+import CoreCommands
 import PackageModel
 import TSCBasic
 

Sources/Commands/Snippets/Cards/SnippetGroupCard.swift

@@ -10,6 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
+import CoreCommands
 import PackageModel
 
 /// A card showing the snippets in a ``SnippetGroup``.

Sources/Commands/Snippets/Cards/TopCard.swift

@@ -10,6 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
+import CoreCommands
 import Foundation
 import PackageModel
 import PackageGraph

Sources/Commands/SwiftBuildTool.swift

@@ -13,9 +13,11 @@
 import ArgumentParser
 import Basics
 import Build
+import CoreCommands
 import PackageGraph
 import SPMBuildCore
 import TSCBasic
+import XCBuildSupport
 
 import enum TSCUtility.Diagnostics
 import func TSCUtility.getClangVersion
@@ -94,7 +96,7 @@ public struct SwiftBuildTool: SwiftCommand {
         helpNames: [.short, .long, .customLong("help", withSingleDash: true)])
 
     @OptionGroup()
-    var globalOptions: GlobalOptions
+    public var globalOptions: GlobalOptions
 
     @OptionGroup()
     var options: BuildToolOptions
@@ -157,8 +159,22 @@ public struct SwiftBuildTool: SwiftCommand {
     public init() {}
 }
 
-extension Basics.Diagnostic {
-    static func mutuallyExclusiveArgumentsError(arguments: [String]) -> Self {
-        .error(arguments.map{ "'\($0)'" }.spm_localizedJoin(type: .conjunction) + " are mutually exclusive")
+extension SwiftCommand {
+    public func buildSystemProvider(_ swiftTool: SwiftTool) throws -> BuildSystemProvider {
+        return .init(providers: try swiftTool.defaultBuildSystemProvider.providers.merging([
+            .xcode: { (explicitProduct: String?, cacheBuildManifest: Bool, customBuildParameters: BuildParameters?, customPackageGraphLoader: (() throws -> PackageGraph)?, customOutputStream: OutputByteStream?, customLogLevel: Basics.Diagnostic.Severity?, customObservabilityScope: ObservabilityScope?) throws -> BuildSystem in
+                let graphLoader = { try swiftTool.loadPackageGraph(explicitProduct: explicitProduct) }
+                return try XcodeBuildSystem(
+                    buildParameters: customBuildParameters ?? swiftTool.buildParameters(),
+                    packageGraphLoader: customPackageGraphLoader ?? graphLoader,
+                    outputStream: customOutputStream ?? swiftTool.outputStream,
+                    logLevel: customLogLevel ?? swiftTool.logLevel,
+                    fileSystem: swiftTool.fileSystem,
+                    observabilityScope: customObservabilityScope ?? swiftTool.observabilityScope
+                )
+            },
+        ], uniquingKeysWith: { a, b in
+            return b
+        }))
     }
 }

Sources/Commands/SwiftPackageCollectionsTool.swift

@@ -12,6 +12,7 @@
 
 import ArgumentParser
 import Basics
+import CoreCommands
 import Foundation
 import PackageCollections
 import PackageModel

Sources/Commands/SwiftPackageRegistryTool.swift

@@ -12,6 +12,7 @@
 
 import ArgumentParser
 import Basics
+import CoreCommands
 import TSCBasic
 import SPMBuildCore
 import PackageModel

Sources/Commands/SwiftPackageTool.swift

@@ -12,6 +12,7 @@
 
 import ArgumentParser
 import Basics
+import CoreCommands
 import TSCBasic
 import SPMBuildCore
 import PackageModel

Sources/Commands/SwiftRunTool.swift

@@ -12,6 +12,7 @@
 
 import ArgumentParser
 import Basics
+import CoreCommands
 import PackageGraph
 import PackageModel
 import TSCBasic
@@ -96,12 +97,12 @@ public struct SwiftRunTool: SwiftCommand {
         helpNames: [.short, .long, .customLong("help", withSingleDash: true)])
 
     @OptionGroup()
-    var globalOptions: GlobalOptions
+    public var globalOptions: GlobalOptions
 
     @OptionGroup()
     var options: RunToolOptions
 
-    var toolWorkspaceConfiguration: ToolWorkspaceConfiguration {
+    public var toolWorkspaceConfiguration: ToolWorkspaceConfiguration {
         return .init(wantsREPLProduct: options.mode == .repl)
     }
 

Sources/Commands/SwiftTestTool.swift

@@ -12,6 +12,7 @@
 
 import ArgumentParser
 import Basics
+import CoreCommands
 import Dispatch
 import class Foundation.NSLock
 import class Foundation.ProcessInfo
@@ -150,7 +151,7 @@ public struct SwiftTestTool: SwiftCommand {
         helpNames: [.short, .long, .customLong("help", withSingleDash: true)])
 
     @OptionGroup()
-    var globalOptions: GlobalOptions
+    public var globalOptions: GlobalOptions
 
     @OptionGroup()
     var sharedOptions: SharedOptions