Bring back experimental-sdk as deprecated for compatibility (#7512)

There are enough users of this command and corresponding options on `swift build` in the wild. These should be deprecated first before removing.

Author: MaxDesiatov

CHANGELOG.md

@@ -3,6 +3,12 @@ Note: This is in reverse chronological order, so newer entries are added to the
 Swift 6.0
 -----------
 
+* [#7507] 
+
+  `swift experimental-sdk` command is deprecated with `swift sdk` command replacing it. `--experimental-swift-sdk` and
+  `--experimental-swift-sdks-path` options on `swift build` are deprecated with replacements that don't have the
+  `experimental` prefix.
+
 * [#7202]
 
   Package manifests can now access information about the Git repository the given package is in via the context object's 
@@ -403,3 +409,4 @@ Swift 3.0
 [#7118]: https://github.com/apple/swift-package-manager/pull/7118
 [#7201]: https://github.com/apple/swift-package-manager/pull/7201
 [#7202]: https://github.com/apple/swift-package-manager/pull/7202
+[#7505]: https://github.com/apple/swift-package-manager/pull/7507

Package.swift

@@ -533,6 +533,12 @@ let package = Package(
             dependencies: ["Commands", "SwiftSDKCommand"],
             exclude: ["CMakeLists.txt"]
         ),
+        .executableTarget(
+            /** Deprecated command superseded by `swift-sdk` */
+            name: "swift-experimental-sdk",
+            dependencies: ["Commands", "SwiftSDKCommand"],
+            exclude: ["CMakeLists.txt"]
+        ),
         .executableTarget(
             /** Runs package tests */
             name: "swift-test",

Sources/CMakeLists.txt

@@ -32,6 +32,7 @@ add_subdirectory(SPMLLBuild)
 add_subdirectory(SPMSQLite3)
 add_subdirectory(swift-bootstrap)
 add_subdirectory(swift-build)
+add_subdirectory(swift-experimental-sdk)
 add_subdirectory(swift-sdk)
 add_subdirectory(swift-package)
 add_subdirectory(swift-run)

Sources/CoreCommands/Options.swift

@@ -111,6 +111,9 @@ package struct LocationOptions: ParsableArguments {
     @Option(name: .customLong("destination"), help: .hidden, completion: .directory)
     package var customCompileDestination: AbsolutePath?
 
+    @Option(name: .customLong("experimental-swift-sdks-path"), help: .hidden, completion: .directory)
+    package var deprecatedSwiftSDKsDirectory: AbsolutePath?
+
     /// Path to the directory containing installed Swift SDKs.
     @Option(
         name: .customLong("swift-sdks-path"),
@@ -410,6 +413,9 @@ package struct BuildOptions: ParsableArguments {
     )
     package var architectures: [String] = []
 
+    @Option(name: .customLong("experimental-swift-sdk"), help: .hidden)
+    package var deprecatedSwiftSDKSelector: String?
+
     /// Filter for selecting a specific Swift SDK to build with.
     @Option(
         name: .customLong("swift-sdk"),

Sources/CoreCommands/SwiftCommandState.swift

@@ -350,8 +350,13 @@ package final class SwiftCommandState {
             fileSystem: fileSystem
         )
         self.sharedCacheDirectory = try getSharedCacheDirectory(options: options, fileSystem: fileSystem)
+        if options.locations.deprecatedSwiftSDKsDirectory != nil {
+            self.observabilityScope.emit(
+                warning: "`--experimental-swift-sdks-path` is deprecated and will be removed in a future version of SwiftPM. Use `--swift-sdks-path` instead."
+            )
+        }
         self.sharedSwiftSDKsDirectory = try fileSystem.getSharedSwiftSDKsDirectory(
-            explicitDirectory: options.locations.swiftSDKsDirectory
+            explicitDirectory: options.locations.swiftSDKsDirectory ?? options.locations.deprecatedSwiftSDKsDirectory
         )
 
         // set global process logging handler
@@ -820,14 +825,20 @@ package final class SwiftCommandState {
         do {
             let hostToolchain = try _hostToolchain.get()
             hostSwiftSDK = hostToolchain.swiftSDK
+
+            if options.build.deprecatedSwiftSDKSelector != nil {
+                self.observabilityScope.emit(
+                    warning: "`--experimental-swift-sdk` is deprecated and will be removed in a future version of SwiftPM. Use `--swift-sdk` instead."
+                )
+            }
             swiftSDK = try SwiftSDK.deriveTargetSwiftSDK(
                 hostSwiftSDK: hostSwiftSDK,
                 hostTriple: hostToolchain.targetTriple,
                 customCompileDestination: options.locations.customCompileDestination,
                 customCompileTriple: options.build.customCompileTriple,
                 customCompileToolchain: options.build.customCompileToolchain,
                 customCompileSDK: options.build.customCompileSDK,
-                swiftSDKSelector: options.build.swiftSDKSelector,
+                swiftSDKSelector: options.build.swiftSDKSelector ?? options.build.deprecatedSwiftSDKSelector,
                 architectures: options.build.architectures,
                 store: store,
                 observabilityScope: self.observabilityScope,

Sources/swift-experimental-sdk/CMakeLists.txt

@@ -0,0 +1,18 @@
+# This source file is part of the Swift open source project
+#
+# Copyright (c) 2023 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
+# See http://swift.org/CONTRIBUTORS.txt for Swift project authors
+
+add_executable(swift-experimental-sdk
+  Entrypoint.swift)
+target_link_libraries(swift-experimental-sdk PRIVATE
+  SwiftSDKCommand)
+
+target_compile_options(swift-experimental-sdk PRIVATE
+  -parse-as-library)
+
+install(TARGETS swift-experimental-sdk
+  RUNTIME DESTINATION bin)

Sources/swift-experimental-sdk/Entrypoint.swift

@@ -0,0 +1,21 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift open source project
+//
+// Copyright (c) 2023 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
+// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import SwiftSDKCommand
+
+@main
+struct Entrypoint {
+    static func main() async {
+        print("warning: `swift experimental-sdk` command is deprecated and will be removed in a future version of SwiftPM. Use `swift sdk` instead.")
+        await SwiftSDKCommand.main()
+    }
+}

Sources/swift-package-manager/SwiftPM.swift

@@ -41,6 +41,9 @@ struct SwiftPM {
             await SwiftPackageCommand.main()
         case "swift-build":
             await SwiftBuildCommand.main()
+        case "swift-experimental-sdk":
+            print("warning: `swift experimental-sdk` command is deprecated and will be removed in a future version of SwiftPM. Use `swift sdk` instead.")
+            fallthrough
         case "swift-sdk":
             await SwiftSDKCommand.main()
         case "swift-test":

Utilities/bootstrap

@@ -435,7 +435,7 @@ def install_swiftpm(prefix, args):
     # Install the swift-package-manager tool and create symlinks to it.
     cli_tool_dest = os.path.join(prefix, "bin")
     install_binary(args, "swift-package-manager", os.path.join(cli_tool_dest, "swift-package"), destination_is_directory=False)
-    for tool in ["swift-build", "swift-test", "swift-run", "swift-package-collection", "swift-package-registry", "swift-sdk"]:
+    for tool in ["swift-build", "swift-test", "swift-run", "swift-package-collection", "swift-package-registry", "swift-sdk", "swift-experimental-sdk"]:
         src = "swift-package"
         dest = os.path.join(cli_tool_dest, tool)
         note("Creating tool symlink from %s to %s" % (src, dest))