Rename "extension" to "plugin" to align with SE-0303. (#3311)

This is a fairly large diff but is just the renaming from "extension" to "plugin" and the related variables and comments.  The name of the runtime library changes too, and some of the methods use different verbs that work better with the noun "plugin".  In some cases there are temporary typealiases to ease transition for clients.

Author: abertelrud

Fixtures/Miscellaneous/Extensions/MySourceGenClient/Package.swift renamed to Fixtures/Miscellaneous/Plugins/MySourceGenClient/Package.swift

@@ -4,21 +4,21 @@ import PackageDescription
 let package = Package(
     name: "MySourceGenClient",
     dependencies: [
-        .package(path: "../MySourceGenExtension")
+        .package(path: "../MySourceGenPlugin")
     ],
     targets: [
-        // A tool that uses an extension.
+        // A tool that uses an plugin.
         .executableTarget(
             name: "MyTool",
             dependencies: [
-                .product(name: "MySourceGenExt", package: "MySourceGenExtension")
+                .product(name: "MySourceGenPlugin", package: "MySourceGenPlugin")
             ]
         ),
-        // A unit that uses the extension.
+        // A unit that uses the plugin.
         .testTarget(
             name: "MyTests",
             dependencies: [
-                .product(name: "MySourceGenExt", package: "MySourceGenExtension")
+                .product(name: "MySourceGenPlugin", package: "MySourceGenPlugin")
             ]
         )
     ]

Fixtures/Miscellaneous/Extensions/MySourceGenClient/Sources/MyTool/Foo.dat renamed to Fixtures/Miscellaneous/Plugins/MySourceGenClient/Sources/MyTool/Foo.dat

@@ -2,29 +2,29 @@
 import PackageDescription
 
 let package = Package(
-    name: "MySourceGenExtension",
+    name: "MySourceGenPlugin",
     products: [
-        // The product that vends MySourceGenExt to client packages.
-        .extension(
-            name: "MySourceGenExt",
-            targets: ["MySourceGenExt"]
+        // The product that vends MySourceGenPlugin to client packages.
+        .plugin(
+            name: "MySourceGenPlugin",
+            targets: ["MySourceGenPlugin"]
         ),
         .executable(
             name: "MySourceGenTool",
             targets: ["MySourceGenTool"]
         )
     ],
     targets: [
-        // A local tool that uses an extension.
+        // A local tool that uses a plugin.
         .executableTarget(
             name: "MyLocalTool",
             dependencies: [
-                "MySourceGenExt",
+                "MySourceGenPlugin",
             ]
         ),
-        // The target that implements the extension and generates commands to invoke MySourceGenTool.
-        .extension(
-            name: "MySourceGenExt",
+        // The target that implements the plugin and generates commands to invoke MySourceGenTool.
+        .plugin(
+            name: "MySourceGenPlugin",
             capability: .buildTool(),
             dependencies: [
                 "MySourceGenTool"
@@ -45,11 +45,11 @@ let package = Package(
         .target(
             name: "MySourceGenRuntimeLib"
         ),
-        // Unit tests for the extension.
+        // Unit tests for the plugin.
         .testTarget(
-            name: "MySourceGenExtTests",
+            name: "MySourceGenPluginTests",
             dependencies: [
-                "MySourceGenExt",
+                "MySourceGenPlugin",
                 "MySourceGenRuntimeLib"
             ]
         )

Fixtures/Miscellaneous/Extensions/MySourceGenClient/Sources/MyTool/main.swift renamed to Fixtures/Miscellaneous/Plugins/MySourceGenClient/Sources/MyTool/main.swift

@@ -1,4 +1,4 @@
-import PackageExtension
+import PackagePlugin
 
 for inputPath in targetBuildContext.otherFiles {
     guard inputPath.suffix == ".dat" else { continue }

Fixtures/Miscellaneous/Extensions/MySourceGenClient/Tests/MyTests/MyTests.swift renamed to Fixtures/Miscellaneous/Plugins/MySourceGenClient/Tests/MyTests/MyTests.swift

@@ -92,9 +92,9 @@ let package = Package(
         ),
 
         .library(
-            name: "PackageExtension",
+            name: "PackagePlugin",
             type: .dynamic,
-            targets: ["PackageExtension"]
+            targets: ["PackagePlugin"]
         ),
 
         .library(
@@ -125,7 +125,7 @@ let package = Package(
             ]),
 
         .target(
-            name: "PackageExtension"),
+            name: "PackagePlugin"),
 
         // MARK: SwiftPM specific support libraries
 

Fixtures/Miscellaneous/Extensions/MySourceGenExtension/Package.swift renamed to Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Package.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright 2015 - 2019 Apple Inc. and the Swift project authors
+ Copyright 2015 - 2021 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See http://swift.org/LICENSE.txt for license information
@@ -31,8 +31,8 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
     /// The closure for loading the package graph.
     let packageGraphLoader: () throws -> PackageGraph
 
-    /// The closure for evaluating extensions in the package graph.
-    let extensionEvaluator: (PackageGraph) throws -> [ResolvedTarget: [ExtensionEvaluationResult]]
+    /// The closure for invoking plugins in the package graph.
+    let pluginInvoker: (PackageGraph) throws -> [ResolvedTarget: [PluginInvocationResult]]
 
     /// The llbuild build delegate reference.
     private var buildSystemDelegate: BuildOperationBuildSystemDelegateHandler?
@@ -63,14 +63,14 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
         buildParameters: BuildParameters,
         cacheBuildManifest: Bool,
         packageGraphLoader: @escaping () throws -> PackageGraph,
-        extensionEvaluator: @escaping (PackageGraph) throws -> [ResolvedTarget: [ExtensionEvaluationResult]],
+        pluginInvoker: @escaping (PackageGraph) throws -> [ResolvedTarget: [PluginInvocationResult]],
         diagnostics: DiagnosticsEngine,
         stdoutStream: OutputByteStream
     ) {
         self.buildParameters = buildParameters
         self.cacheBuildManifest = cacheBuildManifest
         self.packageGraphLoader = packageGraphLoader
-        self.extensionEvaluator = extensionEvaluator
+        self.pluginInvoker = pluginInvoker
         self.diagnostics = diagnostics
         self.stdoutStream = stdoutStream
     }
@@ -81,8 +81,8 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
         }
     }
 
-    public func getExtensionEvaluationResults(for graph: PackageGraph) throws -> [ResolvedTarget: [ExtensionEvaluationResult]] {
-        return try self.extensionEvaluator(graph)
+    public func getPluginInvocationResults(for graph: PackageGraph) throws -> [ResolvedTarget: [PluginInvocationResult]] {
+        return try self.pluginInvoker(graph)
     }
 
     /// Compute and return the latest build description.
@@ -166,11 +166,11 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
     /// Create the build plan and return the build description.
     private func plan() throws -> BuildDescription {
         let graph = try getPackageGraph()
-        let extensionEvaluationResults = try getExtensionEvaluationResults(for: graph)
+        let pluginInvocationResults = try getPluginInvocationResults(for: graph)
         let plan = try BuildPlan(
             buildParameters: buildParameters,
             graph: graph,
-            extensionEvaluationResults: extensionEvaluationResults,
+            pluginInvocationResults: pluginInvocationResults,
             diagnostics: diagnostics
         )
         self.buildPlan = plan

Fixtures/Miscellaneous/Extensions/MySourceGenExtension/Sources/MyLocalTool/Foo.dat renamed to Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Sources/MyLocalTool/Foo.dat

@@ -541,14 +541,14 @@ public final class SwiftTargetBuildDescription {
     /// The modulemap file for this target, if any.
     private(set) var moduleMap: AbsolutePath?
 
-    /// The results of having applied any extensions to this target.
-    public let extensionEvaluationResults: [ExtensionEvaluationResult]
+    /// The results of applying any plugins to this target.
+    public let pluginInvocationResults: [PluginInvocationResult]
 
     /// Create a new target description with target and build parameters.
     init(
         target: ResolvedTarget,
         buildParameters: BuildParameters,
-        extensionEvaluationResults: [ExtensionEvaluationResult] = [],
+        pluginInvocationResults: [PluginInvocationResult] = [],
         isTestTarget: Bool? = nil,
         testDiscoveryTarget: Bool = false,
         fs: FileSystem = localFileSystem
@@ -562,12 +562,12 @@ public final class SwiftTargetBuildDescription {
         self.fs = fs
         self.tempsPath = buildParameters.buildPath.appending(component: target.c99name + ".build")
         self.derivedSources = Sources(paths: [], root: tempsPath.appending(component: "DerivedSources"))
-        self.extensionEvaluationResults = extensionEvaluationResults
+        self.pluginInvocationResults = pluginInvocationResults
 
-        // Add any derived source paths declared by build-tool extensions that were applied to this target.  We do
+        // Add any derived source paths declared by build-tool plugins that were applied to this target.  We do
         // this here and not just in the LLBuildManifestBuilder because we need to include them in any situation
         // where sources are processed, e.g. when determining names of object files, etc.
-        for command in extensionEvaluationResults.reduce([], { $0 + $1.commands }) {
+        for command in pluginInvocationResults.reduce([], { $0 + $1.commands }) {
             // Prebuild and postbuild commands are handled outside the build system.
             if case .buildToolCommand(_, _, _, _, _, _, _, let derivedSourcePaths) = command {
                 // TODO: What should we do if we find non-Swift sources here?
@@ -717,7 +717,7 @@ public final class SwiftTargetBuildDescription {
         case .library, .test:
             result.append("-parse-as-library")
 
-        case .executable, .systemModule, .binary, .extension:
+        case .executable, .systemModule, .binary, .plugin:
             do { }
         }
 
@@ -1133,8 +1133,8 @@ public final class ProductBuildDescription {
                 }
             }
             args += ["-emit-executable"]
-        case .extension:
-            throw InternalError("unexpectedly asked to generate linker arguments for an extension product")
+        case .plugin:
+            throw InternalError("unexpectedly asked to generate linker arguments for a plugin product")
         }
 
         // Set rpath such that dynamic libraries are looked up
@@ -1150,7 +1150,7 @@ public final class ProductBuildDescription {
         // Embed the swift stdlib library path inside tests and executables on Darwin.
         if containsSwiftTargets {
           switch product.type {
-          case .library, .extension: break
+          case .library, .plugin: break
           case .test, .executable:
               if buildParameters.triple.isDarwin() {
                   let stdlib = buildParameters.toolchain.macosSwiftStdlib
@@ -1275,8 +1275,8 @@ public class BuildPlan {
         return AnySequence(productMap.values)
     }
 
-    /// The results of evaluating any extensions used by targets in this build.
-    public let extensionEvaluationResults: [ResolvedTarget: [ExtensionEvaluationResult]]
+    /// The results of invoking any plugins used by targets in this build.
+    public let pluginInvocationResults: [ResolvedTarget: [PluginInvocationResult]]
 
     /// The filesystem to operate on.
     let fileSystem: FileSystem
@@ -1357,13 +1357,13 @@ public class BuildPlan {
     public init(
         buildParameters: BuildParameters,
         graph: PackageGraph,
-        extensionEvaluationResults: [ResolvedTarget: [ExtensionEvaluationResult]] = [:],
+        pluginInvocationResults: [ResolvedTarget: [PluginInvocationResult]] = [:],
         diagnostics: DiagnosticsEngine,
         fileSystem: FileSystem = localFileSystem
     ) throws {
         self.buildParameters = buildParameters
         self.graph = graph
-        self.extensionEvaluationResults = extensionEvaluationResults
+        self.pluginInvocationResults = pluginInvocationResults
         self.diagnostics = diagnostics
         self.fileSystem = fileSystem
 
@@ -1388,15 +1388,15 @@ public class BuildPlan {
                 targetMap[target] = try .swift(SwiftTargetBuildDescription(
                     target: target,
                     buildParameters: buildParameters,
-                    extensionEvaluationResults: extensionEvaluationResults[target] ?? [],
+                    pluginInvocationResults: pluginInvocationResults[target] ?? [],
                     fs: fileSystem))
             case is ClangTarget:
                 targetMap[target] = try .clang(ClangTargetBuildDescription(
                     target: target,
                     buildParameters: buildParameters,
                     fileSystem: fileSystem,
                     diagnostics: diagnostics))
-            case is SystemLibraryTarget, is BinaryTarget, is ExtensionTarget:
+            case is SystemLibraryTarget, is BinaryTarget, is PluginTarget:
                  break
             default:
                  fatalError("unhandled \(target.underlyingTarget)")
@@ -1424,8 +1424,8 @@ public class BuildPlan {
 
         var productMap: [ResolvedProduct: ProductBuildDescription] = [:]
         // Create product description for each product we have in the package graph except
-        // for automatic libraries and extension because they don't produce any output.
-        for product in graph.allProducts where product.type != .library(.automatic) && product.type != .extension {
+        // for automatic libraries and plugins, because they don't produce any output.
+        for product in graph.allProducts where product.type != .library(.automatic) && product.type != .plugin {
             productMap[product] = ProductBuildDescription(
                 product: product, buildParameters: buildParameters,
                 fs: fileSystem,
@@ -1591,10 +1591,10 @@ public class BuildPlan {
                 return target.dependencies.filter { $0.satisfies(self.buildEnvironment) }
 
             // For a product dependency, we only include its content only if we
-            // need to statically link it or if it's an extension.
+            // need to statically link it or if it's a plugin.
             case .product(let product, _):
                 switch product.type {
-                case .library(.automatic), .library(.static), .extension:
+                case .library(.automatic), .library(.static), .plugin:
                     return product.targets.map { .target($0, conditions: []) }
                 case .library(.dynamic), .test, .executable:
                     return []
@@ -1640,7 +1640,7 @@ public class BuildPlan {
                         let tools = try self.parseArtifactsArchive(for: binaryTarget)
                         tools.forEach { availableTools[$0.name] = $0.executablePath  }
                     }
-                case .extension:
+                case .plugin:
                     continue
                 }
 

Fixtures/Miscellaneous/Extensions/MySourceGenExtension/Sources/MyLocalTool/main.swift renamed to Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Sources/MyLocalTool/main.swift

@@ -510,8 +510,8 @@ extension LLBuildManifestBuilder {
             if target.underlyingTarget is SystemLibraryTarget { return }
             // Ignore Binary Modules.
             if target.underlyingTarget is BinaryTarget { return }
-            // Ignore Extension Targets.
-            if target.underlyingTarget is ExtensionTarget { return }
+            // Ignore Plugin Targets.
+            if target.underlyingTarget is PluginTarget { return }
 
             // Depend on the binary for executable targets.
             if target.type == .executable {
@@ -554,8 +554,8 @@ extension LLBuildManifestBuilder {
                     // Establish a dependency on binary of the product.
                     inputs.append(file: planProduct.binary)
 
-                // For automatic and static libraries, and extensions, add their targets as static input.
-                case .library(.automatic), .library(.static), .extension:
+                // For automatic and static libraries, and plugins, add their targets as static input.
+                case .library(.automatic), .library(.static), .plugin:
                     for target in product.targets {
                         try addStaticTargetInputs(target)
                     }
@@ -575,8 +575,8 @@ extension LLBuildManifestBuilder {
             }
         }
 
-        // Add any build tool commands created by extensions for the target (prebuild and postbuild commands are handled outside the build).
-        for command in target.extensionEvaluationResults.reduce([], { $0 + $1.commands }) {
+        // Add any build tool commands created by plugins for the target (prebuild and postbuild commands are handled outside the build).
+        for command in target.pluginInvocationResults.reduce([], { $0 + $1.commands }) {
             if case .buildToolCommand(let displayName, let executable, let arguments, _, _, let inputPaths, let outputPaths, _) = command {
                 // Create a shell command to invoke the executable.  We include the path of the executable as a dependency.
                 // FIXME: We will need to extend the addShellCmd() function to also take working directory and environment.
@@ -674,7 +674,7 @@ extension LLBuildManifestBuilder {
                     let binary = planProduct.binary
                     inputs.append(file: binary)
 
-                case .library(.automatic), .library(.static), .extension:
+                case .library(.automatic), .library(.static), .plugin:
                     for target in product.targets {
                         addStaticTargetInputs(target)
                     }
@@ -847,8 +847,8 @@ extension ResolvedProduct {
             throw InternalError("automatic library not supported")
         case .executable:
             return "\(name)-\(config).exe"
-        case .extension:
-            throw InternalError("unexpectedly asked for the llbuild target name of an extension product")
+        case .plugin:
+            throw InternalError("unexpectedly asked for the llbuild target name of a plugin product")
         }
     }
 

Fixtures/Miscellaneous/Extensions/MySourceGenExtension/Sources/MySourceGenExt/extension.swift renamed to Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Sources/MySourceGenPlugin/plugin.swift

@@ -14,10 +14,10 @@ add_subdirectory(PackageCollections)
 add_subdirectory(PackageCollectionsModel)
 add_subdirectory(PackageCollectionsSigning)
 add_subdirectory(PackageDescription)
-add_subdirectory(PackageExtension)
 add_subdirectory(PackageGraph)
 add_subdirectory(PackageLoading)
 add_subdirectory(PackageModel)
+add_subdirectory(PackagePlugin)
 add_subdirectory(SPMBuildCore)
 add_subdirectory(SPMLLBuild)
 add_subdirectory(SourceControl)

Fixtures/Miscellaneous/Extensions/MySourceGenExtension/Sources/MySourceGenRuntimeLib/library.swift renamed to Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Sources/MySourceGenRuntimeLib/library.swift

@@ -112,7 +112,7 @@ struct APIDigesterBaselineDumper {
             buildParameters: buildParameters,
             cacheBuildManifest: false,
             packageGraphLoader: { graph },
-            extensionEvaluator: { _ in [:] },
+            pluginInvoker: { _ in [:] },
             diagnostics: diags,
             stdoutStream: stdoutStream
         )