Rename Swift*Tool to Swift*Command (#7336)

This removes an existing point of confusion, where `SwiftBuildTool` that
handles `swift build` CLI invocations could be misunderstood as
something responsible for build tools in plugins. It becomes especially
problematic when working on the plugins codebase.

Additionally, `SwiftTool` is a grab bag reference type for storing state
injected into a CLI command, so we should rename it to
`SwiftCommandState` for clarity.

Author: MaxDesiatov

.swiftpm/xcode/xcshareddata/xcschemes/SwiftPM-Package.xcscheme

@@ -416,7 +416,7 @@ let package = Package(
 
         .target(
             /** Interacts with Swift SDKs used for cross-compilation */
-            name: "SwiftSDKTool",
+            name: "SwiftSDKCommand",
             dependencies: [
                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
                 "Basics",
@@ -429,7 +429,7 @@ let package = Package(
 
         .target(
             /** Interacts with package collections */
-            name: "PackageCollectionsTool",
+            name: "PackageCollectionsCommand",
             dependencies: [
                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
                 "Basics",
@@ -442,7 +442,7 @@ let package = Package(
 
         .target(
             /** Interact with package registry */
-            name: "PackageRegistryTool",
+            name: "PackageRegistryCommand",
             dependencies: [
                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
                 "Basics",
@@ -488,7 +488,7 @@ let package = Package(
         .executableTarget(
             /** Interacts with Swift SDKs used for cross-compilation */
             name: "swift-experimental-sdk",
-            dependencies: ["Commands", "SwiftSDKTool"],
+            dependencies: ["Commands", "SwiftSDKCommand"],
             exclude: ["CMakeLists.txt"]
         ),
         .executableTarget(
@@ -506,24 +506,24 @@ let package = Package(
         .executableTarget(
             /** Interacts with package collections */
             name: "swift-package-collection",
-            dependencies: ["Commands", "PackageCollectionsTool"]
+            dependencies: ["Commands", "PackageCollectionsCommand"]
         ),
         .executableTarget(
-            /** Multi-tool entry point for SwiftPM. */
+            /** Multi-command entry point for SwiftPM. */
             name: "swift-package-manager",
             dependencies: [
                 "Basics",
                 "Commands",
-                "SwiftSDKTool",
-                "PackageCollectionsTool",
-                "PackageRegistryTool"
+                "SwiftSDKCommand",
+                "PackageCollectionsCommand",
+                "PackageRegistryCommand"
             ],
             linkerSettings: swiftpmLinkSettings
         ),
         .executableTarget(
             /** Interact with package registry */
             name: "swift-package-registry",
-            dependencies: ["Commands", "PackageRegistryTool"]
+            dependencies: ["Commands", "PackageRegistryCommand"]
         ),
 
         // MARK: Support for Swift macros, should eventually move to a plugin-based solution
@@ -721,7 +721,7 @@ if ProcessInfo.processInfo.environment["SWIFTCI_DISABLE_SDK_DEPENDENT_TESTS"] ==
                 "Build",
                 "Commands",
                 "PackageModel",
-                "PackageRegistryTool",
+                "PackageRegistryCommand",
                 "SourceControl",
                 "SPMTestSupport",
                 "Workspace",

Package.swift

@@ -9,13 +9,11 @@
 add_compile_definitions(SKIP_RESOURCE_SUPPORT)
 add_compile_definitions(USE_IMPL_ONLY_IMPORTS)
 
-add_subdirectory(SPMSQLite3)
 add_subdirectory(Basics)
 add_subdirectory(Build)
 add_subdirectory(Commands)
 add_subdirectory(CompilerPluginSupport)
 add_subdirectory(CoreCommands)
-add_subdirectory(SwiftSDKTool)
 add_subdirectory(DriverSupport)
 add_subdirectory(LLBuildManifest)
 add_subdirectory(PackageDescription)
@@ -26,14 +24,16 @@ add_subdirectory(PackageModel)
 add_subdirectory(PackagePlugin)
 add_subdirectory(PackageRegistry)
 add_subdirectory(PackageSigning)
-add_subdirectory(SPMBuildCore)
-add_subdirectory(SPMLLBuild)
 add_subdirectory(SourceControl)
 add_subdirectory(SourceKitLSPAPI)
+add_subdirectory(SPMBuildCore)
+add_subdirectory(SPMLLBuild)
+add_subdirectory(SPMSQLite3)
 add_subdirectory(swift-bootstrap)
 add_subdirectory(swift-build)
 add_subdirectory(swift-experimental-sdk)
 add_subdirectory(swift-package)
 add_subdirectory(swift-run)
 add_subdirectory(swift-test)
+add_subdirectory(SwiftSDKCommand)
 add_subdirectory(Workspace)

Sources/CMakeLists.txt

@@ -7,36 +7,36 @@
 # See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 
 add_library(Commands
-  PackageTools/APIDiff.swift
-  PackageTools/ArchiveSource.swift
-  PackageTools/CompletionTool.swift
-  PackageTools/ComputeChecksum.swift
-  PackageTools/Config.swift
-  PackageTools/Describe.swift
-  PackageTools/DumpCommands.swift
-  PackageTools/EditCommands.swift
-  PackageTools/Format.swift
-  PackageTools/Init.swift
-  PackageTools/InstalledPackages.swift
-  PackageTools/Learn.swift
-  PackageTools/PluginCommand.swift
-  PackageTools/ResetCommands.swift
-  PackageTools/Resolve.swift
-  PackageTools/ShowDependencies.swift
-  PackageTools/SwiftPackageTool.swift
-  PackageTools/ToolsVersionCommand.swift
-  PackageTools/Update.swift
+  PackageCommands/APIDiff.swift
+  PackageCommands/ArchiveSource.swift
+  PackageCommands/CompletionCommand.swift
+  PackageCommands/ComputeChecksum.swift
+  PackageCommands/Config.swift
+  PackageCommands/Describe.swift
+  PackageCommands/DumpCommands.swift
+  PackageCommands/EditCommands.swift
+  PackageCommands/Format.swift
+  PackageCommands/Init.swift
+  PackageCommands/InstalledPackages.swift
+  PackageCommands/Learn.swift
+  PackageCommands/PluginCommand.swift
+  PackageCommands/ResetCommands.swift
+  PackageCommands/Resolve.swift
+  PackageCommands/ShowDependencies.swift
+  PackageCommands/SwiftPackageCommand.swift
+  PackageCommands/ToolsVersionCommand.swift
+  PackageCommands/Update.swift
   Snippets/CardEvent.swift
   Snippets/Cards/SnippetCard.swift
   Snippets/Cards/SnippetGroupCard.swift
   Snippets/Cards/TopCard.swift
   Snippets/CardStack.swift
   Snippets/Card.swift
   Snippets/Colorful.swift
-  SwiftBuildTool.swift
-  SwiftRunTool.swift
-  SwiftTestTool.swift
-  ToolWorkspaceDelegate.swift
+  SwiftBuildCommand.swift
+  SwiftRunCommand.swift
+  SwiftTestCommand.swift
+  CommandWorkspaceDelegate.swift
   Utilities/APIDigester.swift
   Utilities/DependenciesSerializer.swift
   Utilities/DescribedPackage.swift

Sources/Commands/CMakeLists.txt

@@ -24,7 +24,7 @@ import Workspace
 import protocol TSCBasic.OutputByteStream
 import struct TSCUtility.Version
 
-class ToolWorkspaceDelegate: WorkspaceDelegate {
+final class CommandWorkspaceDelegate: WorkspaceDelegate {
     private struct DownloadProgress {
         let bytesDownloaded: Int64
         let totalBytesToDownload: Int64
@@ -267,7 +267,7 @@ class ToolWorkspaceDelegate: WorkspaceDelegate {
 public extension _SwiftCommand {
     var workspaceDelegateProvider: WorkspaceDelegateProvider {
         return {
-            ToolWorkspaceDelegate(
+            CommandWorkspaceDelegate(
                 observabilityScope: $0,
                 outputHandler: $1,
                 progressHandler: $2,

Sources/Commands/ToolWorkspaceDelegate.swift renamed to Sources/Commands/CommandWorkspaceDelegate.swift

@@ -74,21 +74,21 @@ struct APIDiff: SwiftCommand {
     @Flag(help: "Regenerate the API baseline, even if an existing one is available.")
     var regenerateBaseline: Bool = false
 
-    func run(_ swiftTool: SwiftTool) throws {
-        let apiDigesterPath = try swiftTool.getTargetToolchain().getSwiftAPIDigester()
-        let apiDigesterTool = SwiftAPIDigester(fileSystem: swiftTool.fileSystem, tool: apiDigesterPath)
+    func run(_ swiftCommandState: SwiftCommandState) throws {
+        let apiDigesterPath = try swiftCommandState.getTargetToolchain().getSwiftAPIDigester()
+        let apiDigesterTool = SwiftAPIDigester(fileSystem: swiftCommandState.fileSystem, tool: apiDigesterPath)
 
-        let packageRoot = try globalOptions.locations.packageDirectory ?? swiftTool.getPackageRoot()
+        let packageRoot = try globalOptions.locations.packageDirectory ?? swiftCommandState.getPackageRoot()
         let repository = GitRepository(path: packageRoot)
         let baselineRevision = try repository.resolveRevision(identifier: treeish)
 
         // We turn build manifest caching off because we need the build plan.
-        let buildSystem = try swiftTool.createBuildSystem(explicitBuildSystem: .native, cacheBuildManifest: false)
+        let buildSystem = try swiftCommandState.createBuildSystem(explicitBuildSystem: .native, cacheBuildManifest: false)
 
         let packageGraph = try buildSystem.getPackageGraph()
         let modulesToDiff = try determineModulesToDiff(
             packageGraph: packageGraph,
-            observabilityScope: swiftTool.observabilityScope
+            observabilityScope: swiftCommandState.observabilityScope
         )
 
         // Build the current package.
@@ -97,19 +97,19 @@ struct APIDiff: SwiftCommand {
         // Dump JSON for the baseline package.
         let baselineDumper = try APIDigesterBaselineDumper(
             baselineRevision: baselineRevision,
-            packageRoot: swiftTool.getPackageRoot(),
+            packageRoot: swiftCommandState.getPackageRoot(),
             productsBuildParameters: try buildSystem.buildPlan.destinationBuildParameters,
             toolsBuildParameters: try buildSystem.buildPlan.toolsBuildParameters,
             apiDigesterTool: apiDigesterTool,
-            observabilityScope: swiftTool.observabilityScope
+            observabilityScope: swiftCommandState.observabilityScope
         )
 
         let baselineDir = try baselineDumper.emitAPIBaseline(
             for: modulesToDiff,
             at: overrideBaselineDir,
             force: regenerateBaseline,
-            logLevel: swiftTool.logLevel,
-            swiftTool: swiftTool
+            logLevel: swiftCommandState.logLevel,
+                    swiftCommandState: swiftCommandState
         )
 
         let results = ThreadSafeArrayStore<SwiftAPIDigester.ComparisonResult>()
@@ -119,7 +119,7 @@ struct APIDiff: SwiftCommand {
 
         for module in modulesToDiff {
             let moduleBaselinePath = baselineDir.appending("\(module).json")
-            guard swiftTool.fileSystem.exists(moduleBaselinePath) else {
+            guard swiftCommandState.fileSystem.exists(moduleBaselinePath) else {
                 print("\nSkipping \(module) because it does not exist in the baseline")
                 skippedModules.insert(module)
                 continue
@@ -136,7 +136,7 @@ struct APIDiff: SwiftCommand {
                         results.append(comparisonResult)
                     }
                 } catch {
-                    swiftTool.observabilityScope.emit(error: "failed to compare API to baseline", underlyingError: error)
+                    swiftCommandState.observabilityScope.emit(error: "failed to compare API to baseline", underlyingError: error)
                 }
                 semaphore.signal()
             }
@@ -148,11 +148,11 @@ struct APIDiff: SwiftCommand {
             .subtracting(skippedModules)
             .subtracting(results.map(\.moduleName))
         for failedModule in failedModules {
-            swiftTool.observabilityScope.emit(error: "failed to read API digester output for \(failedModule)")
+            swiftCommandState.observabilityScope.emit(error: "failed to read API digester output for \(failedModule)")
         }
 
         for result in results.get() {
-            try self.printComparisonResult(result, observabilityScope: swiftTool.observabilityScope)
+            try self.printComparisonResult(result, observabilityScope: swiftCommandState.observabilityScope)
         }
 
         guard failedModules.isEmpty && results.get().allSatisfy(\.hasNoAPIBreakingChanges) else {

Sources/Commands/PackageTools/APIDiff.swift renamed to Sources/Commands/PackageCommands/APIDiff.swift

@@ -15,7 +15,7 @@ import Basics
 import CoreCommands
 import SourceControl
 
-extension SwiftPackageTool {
+extension SwiftPackageCommand {
     struct ArchiveSource: SwiftCommand {
         static let configuration = CommandConfiguration(
             commandName: "archive-source",
@@ -31,23 +31,23 @@ extension SwiftPackageTool {
         )
         var output: AbsolutePath?
 
-        func run(_ swiftTool: SwiftTool) throws {
-            let packageDirectory = try globalOptions.locations.packageDirectory ?? swiftTool.getPackageRoot()
+        func run(_ swiftCommandState: SwiftCommandState) throws {
+            let packageDirectory = try globalOptions.locations.packageDirectory ?? swiftCommandState.getPackageRoot()
 
             let archivePath: AbsolutePath
             if let output {
                 archivePath = output
             } else {
-                let graph = try swiftTool.loadPackageGraph()
+                let graph = try swiftCommandState.loadPackageGraph()
                 let packageName = graph.rootPackages[graph.rootPackages.startIndex].manifest.displayName // TODO: use identity instead?
                 archivePath = packageDirectory.appending("\(packageName).zip")
             }
 
-            try SwiftPackageTool.archiveSource(
+            try SwiftPackageCommand.archiveSource(
                 at: packageDirectory,
                 to: archivePath,
                 fileSystem: localFileSystem,
-                cancellator: swiftTool.cancellator
+                cancellator: swiftCommandState.cancellator
             )
 
             if archivePath.isDescendantOfOrEqual(to: packageDirectory) {

Sources/Commands/PackageTools/ArchiveSource.swift renamed to Sources/Commands/PackageCommands/ArchiveSource.swift

@@ -15,10 +15,10 @@ import CoreCommands
 
 import var TSCBasic.stdoutStream
 
-extension SwiftPackageTool {
-    struct CompletionTool: SwiftCommand {
+extension SwiftPackageCommand {
+    struct CompletionCommand: SwiftCommand {
         static let configuration = CommandConfiguration(
-            abstract: "Completion tool (for shell completions)"
+            abstract: "Completion command (for shell completions)"
         )
 
         enum Mode: String, CaseIterable, ExpressibleByArgument {
@@ -37,10 +37,10 @@ extension SwiftPackageTool {
                 commandName: "swift",
                 abstract: "The Swift compiler",
                 subcommands: [
-                    SwiftRunTool.self,
-                    SwiftBuildTool.self,
-                    SwiftTestTool.self,
-                    SwiftPackageTool.self,
+                    SwiftRunCommand.self,
+                    SwiftBuildCommand.self,
+                    SwiftTestCommand.self,
+                    SwiftPackageCommand.self,
                 ]
             )
         }
@@ -51,7 +51,7 @@ extension SwiftPackageTool {
         @Argument(help: "generate-bash-script | generate-zsh-script |\ngenerate-fish-script | list-dependencies | list-executables")
         var mode: Mode
 
-        func run(_ swiftTool: SwiftTool) throws {
+        func run(_ swiftCommandState: SwiftCommandState) throws {
             switch mode {
             case .generateBashScript:
                 let script = SwiftCommand.completionScript(for: .bash)
@@ -63,7 +63,7 @@ extension SwiftPackageTool {
                 let script = SwiftCommand.completionScript(for: .fish)
                 print(script)
             case .listDependencies:
-                let graph = try swiftTool.loadPackageGraph()
+                let graph = try swiftCommandState.loadPackageGraph()
                 // command's result output goes on stdout
                 // ie "swift package list-dependencies" should output to stdout
                 ShowDependencies.dumpDependenciesOf(
@@ -72,14 +72,14 @@ extension SwiftPackageTool {
                     on: TSCBasic.stdoutStream
                 )
             case .listExecutables:
-                let graph = try swiftTool.loadPackageGraph()
+                let graph = try swiftCommandState.loadPackageGraph()
                 let package = graph.rootPackages[graph.rootPackages.startIndex].underlying
                 let executables = package.targets.filter { $0.type == .executable }
                 for executable in executables {
                     print(executable.name)
                 }
             case .listSnippets:
-                let graph = try swiftTool.loadPackageGraph()
+                let graph = try swiftCommandState.loadPackageGraph()
                 let package = graph.rootPackages[graph.rootPackages.startIndex].underlying
                 let executables = package.targets.filter { $0.type == .snippet }
                 for executable in executables {

Sources/Commands/PackageTools/CompletionTool.swift renamed to Sources/Commands/PackageCommands/CompletionCommand.swift

@@ -27,11 +27,11 @@ struct ComputeChecksum: SwiftCommand {
     @Argument(help: "The absolute or relative path to the binary artifact")
     var path: AbsolutePath
 
-    func run(_ swiftTool: SwiftTool) throws {
+    func run(_ swiftCommandState: SwiftCommandState) throws {
         let binaryArtifactsManager = try Workspace.BinaryArtifactsManager(
-            fileSystem: swiftTool.fileSystem,
-            authorizationProvider: swiftTool.getAuthorizationProvider(),
-            hostToolchain: swiftTool.getHostToolchain(),
+            fileSystem: swiftCommandState.fileSystem,
+            authorizationProvider: swiftCommandState.getAuthorizationProvider(),
+            hostToolchain: swiftCommandState.getHostToolchain(),
             checksumAlgorithm: SHA256(),
             cachePath: .none,
             customHTTPClient: .none,