Allow for .package(url: String, revision: String) syntax

CHANGELOG.md

@@ -1,13 +1,19 @@
 Note: This is in reverse chronological order, so newer entries are added to the top.
 
 Swift v.Next
------------
+ -----------
+ * [#3310]
+    * Improvements
+
+    Adding a dependency requirement can now be done with the convenience initializer `.package(url: String, revision: String)`.
+
 * [#3292]
    * Improvements
 
    Adding a dependency requirement can now be done with the convenience initializer `.package(url: String, branch: String)`.
 
 
+
 Swift 5.4
 -----------
 * [#2937]

Documentation/PackageDescription.md

@@ -306,6 +306,16 @@ static func package(url: String, _ requirement: Package.Dependency.Requirement)
 ///     - branch: A dependency requirement. See static methods on `Package.Dependency.Requirement` for available options.
 static func package(name: String? = nil, url: String, branch: String) -> Package.Dependency
 
+/// Adds a remote package dependency given a revision requirement.
+///
+///    .package(url: "https://example.com/example-package.git", revision: "aa681bd6c61e22df0fd808044a886fc4a7ed3a65"),
+///
+/// - Parameters:
+///     - name: The name of the package, or nil to deduce it from the URL.
+///     - url: The valid Git URL of the package.
+///     - revision: A dependency requirement. See static methods on `Package.Dependency.Requirement` for available options.
+static func package(name: String? = nil, url: String, revision: String) -> Package.Dependency
+
 /// Add a package dependency starting with a specific minimum version, up to
 /// but not including a specified maximum version.
 ///

Sources/PackageDescription/PackageDependency.swift

@@ -81,7 +81,24 @@ extension Package.Dependency {
     ) -> Package.Dependency {
         return .init(name: name, url: url, requirement: .branch(branch))
     }
-
+
+    /// Adds a remote package dependency given a revision requirement.
+    ///
+    ///    .package(url: "https://example.com/example-package.git", revision: "aa681bd6c61e22df0fd808044a886fc4a7ed3a65"),
+    ///
+    /// - Parameters:
+    ///     - name: The name of the package, or nil to deduce it from the URL.
+    ///     - url: The valid Git URL of the package.
+    ///     - revision: A dependency requirement. See static methods on `Package.Dependency.Requirement` for available options.
+    @available(_PackageDescription, introduced: 999.0)
+    public static func package(
+        name: String? = nil,
+        url: String,
+        revision: String
+    ) -> Package.Dependency {
+        return .init(name: name, url: url, requirement: .revision(revision))
+    }
+
     /// Adds a remote package dependency given a version requirement.
     ///
     /// - Parameters:
@@ -266,11 +283,6 @@ extension Package.Dependency {
         fatalError()
     }
 
-    @available(*, unavailable, message: "use package(url:_:) with the .revision(String) initializer instead")
-    public static func package(url: String, revision: String) -> Package.Dependency {
-        fatalError()
-    }
-
     @available(*, unavailable, message: "use package(url:_:) without the range label instead")
     public static func package(url: String, range: Range<Version>) -> Package.Dependency {
         fatalError()

Tests/PackageLoadingTests/PD4_0LoadingTests.swift

@@ -135,18 +135,18 @@ class PackageDescription4_0LoadingTests: PackageDescriptionLoadingTests {
                    .package(url: "/foo2", .upToNextMajor(from: "1.0.0")),
                    .package(url: "/foo3", .upToNextMinor(from: "1.0.0")),
                    .package(url: "/foo4", .exact("1.0.0")),
-                   .package(url: "/foo5", .branch("master")),
+                   .package(url: "/foo5", .branch("main")),
                    .package(url: "/foo6", .revision("58e9de4e7b79e67c72a46e164158e3542e570ab6")),
                ]
             )
             """
-       loadManifest(stream.bytes) { manifest in
+        loadManifest(stream.bytes, toolsVersion: ToolsVersion(string: "999.0")) { manifest in
         let deps = Dictionary(uniqueKeysWithValues: manifest.dependencies.map{ ($0.identity.description, $0) })
             XCTAssertEqual(deps["foo1"], .scm(location: "/foo1", requirement: .upToNextMajor(from: "1.0.0")))
             XCTAssertEqual(deps["foo2"], .scm(location: "/foo2", requirement: .upToNextMajor(from: "1.0.0")))
             XCTAssertEqual(deps["foo3"], .scm(location: "/foo3", requirement: .upToNextMinor(from: "1.0.0")))
             XCTAssertEqual(deps["foo4"], .scm(location: "/foo4", requirement: .exact("1.0.0")))
-            XCTAssertEqual(deps["foo5"], .scm(location: "/foo5", requirement: .branch("master")))
+            XCTAssertEqual(deps["foo5"], .scm(location: "/foo5", requirement: .branch("main")))
             XCTAssertEqual(deps["foo6"], .scm(location: "/foo6", requirement: .revision("58e9de4e7b79e67c72a46e164158e3542e570ab6")))
         }
     }
@@ -299,7 +299,6 @@ class PackageDescription4_0LoadingTests: PackageDescriptionLoadingTests {
             XCTFail("this package should not load succesfully")
         } catch ManifestParseError.invalidManifestFormat(let error, _) {
             XCTAssert(error.contains("error: 'package(url:version:)' is unavailable: use package(url:_:) with the .exact(Version) initializer instead\n"), "\(error)")
-            XCTAssert(error.contains("error: 'package(url:revision:)' is unavailable: use package(url:_:) with the .revision(String) initializer instead\n"), "\(error)")
             XCTAssert(error.contains("error: 'package(url:range:)' is unavailable: use package(url:_:) without the range label instead\n"), "\(error)")
         }
     }

Tests/PackageLoadingTests/PDNextVersionLoadingTests.swift

@@ -83,4 +83,23 @@ class PackageDescriptionNextVersionLoadingTests: PackageDescriptionLoadingTests
             XCTAssertEqual(manifest.targets[0].extensionCapability, .postbuild)
         }
     }
+
+    func testPackageDependencies() throws {
+        let stream = BufferedOutputByteStream()
+        stream <<< """
+            import PackageDescription
+            let package = Package(
+               name: "Foo",
+               dependencies: [
+                   .package(url: "/foo5", branch: "main"),
+                   .package(url: "/foo7", revision: "58e9de4e7b79e67c72a46e164158e3542e570ab6"),
+               ]
+            )
+            """
+        loadManifest(stream.bytes, toolsVersion: ToolsVersion(string: "999.0")) { manifest in
+        let deps = Dictionary(uniqueKeysWithValues: manifest.dependencies.map{ ($0.identity.description, $0) })
+            XCTAssertEqual(deps["foo5"], .scm(location: "/foo5", requirement: .branch("main")))
+            XCTAssertEqual(deps["foo7"], .scm(location: "/foo7", requirement: .revision("58e9de4e7b79e67c72a46e164158e3542e570ab6")))
+        }
+    }
 }