Render package dependencies with the SwiftPM 5.5 syntax

Modern SwiftPM implementations warn about the

  .package(url: "https://github.com/apple/swift-system.git", .branch("main"))

syntax that's being rendered into the package manifest, because this syntax
was replaced in SwiftPM 5.5 with something that uses argument labels:

  .package(url: "https://github.com/apple/swift-system.git", branch: "main")

Since generating code with warnings is bad, and we've already stated
that we won't edit packages for tools version < 5.5, switch to this new
style.

This does mean that we drop the (internal) dependency on
ManifestSourceGeneration, which is producing the older format, because
I don't have a strong sense of whether we can modernize that code.
Instead, we have a new path that generates swift-syntax nodes directly
for the types we generate.

Author: DougGregor

Sources/PackageModel/ManifestSourceGeneration.swift

@@ -62,7 +62,7 @@ public typealias ManifestCustomProductTypeSourceGenerator = (ProductDescription)
 
 
 /// Convenience initializers for package manifest structures.
-package extension SourceCodeFragment {
+fileprivate extension SourceCodeFragment {
 
     /// Instantiates a SourceCodeFragment to represent an entire manifest.
     init(
@@ -633,7 +633,7 @@ public struct SourceCodeFragment {
         self.subnodes = subnodes
     }
 
-    package func generateSourceCode(indent: String = "") -> String {
+    func generateSourceCode(indent: String = "") -> String {
         var string = literal
         if let subnodes {
             switch delimiters {

Sources/PackageModelSyntax/AddPackageDependency.swift

@@ -48,7 +48,7 @@ public struct AddPackageDependency {
             throw ManifestEditError.cannotFindPackage
         }
 
-        let dependencySyntax = dependency.asSyntax(manifestDirectory: manifestDirectory)
+        let dependencySyntax = dependency.asSyntax()
 
         // If there is already a "dependencies" argument, append to the array
         // literal in there.

Sources/PackageModelSyntax/ManifestSyntaxRepresentable.swift

@@ -36,5 +36,5 @@ protocol ManifestSyntaxRepresentable {
     /// For example, a `PackageDependency` entity would map to syntax for
     /// something like
     ///     .package(url: "https://github.com/apple/swift-syntax.git", from: "510.0.1")
-    func asSyntax(manifestDirectory: AbsolutePath) -> PreferredSyntax
+    func asSyntax() -> PreferredSyntax
 }

Sources/PackageModelSyntax/PackageDependency+Syntax.swift

@@ -14,10 +14,80 @@ import Basics
 import PackageModel
 import SwiftSyntax
 import SwiftParser
+import struct TSCUtility.Version
 
 extension PackageDependency: ManifestSyntaxRepresentable {
-    func asSyntax(manifestDirectory: AbsolutePath) -> ExprSyntax {
-        let fragment = SourceCodeFragment(from: self, pathAnchor: manifestDirectory)
-        return "\(raw: fragment.generateSourceCode())"
+    func asSyntax() -> ExprSyntax {
+        switch self {
+        case .fileSystem(let filesystem): filesystem.asSyntax()
+        case .sourceControl(let sourceControl): sourceControl.asSyntax()
+        case .registry(let registry): registry.asSyntax()
+        }
+    }
+}
+
+extension PackageDependency.FileSystem: ManifestSyntaxRepresentable {
+    func asSyntax() -> ExprSyntax {
+        fatalError()
+    }
+}
+
+extension PackageDependency.SourceControl: ManifestSyntaxRepresentable {
+    func asSyntax() -> ExprSyntax {
+        // TODO: Not handling identity, nameForTargetDependencyResolutionOnly,
+        // or productFilter yet.
+        switch location {
+        case .local(let path):
+            ".package(path: \(literal: path.description), \(requirement.asSyntax()))"
+        case .remote(let url):
+            ".package(url: \(literal: url.description), \(requirement.asSyntax()))"
+        }
+    }
+}
+
+extension PackageDependency.Registry: ManifestSyntaxRepresentable {
+    func asSyntax() -> ExprSyntax {
+        fatalError()
+    }
+}
+
+extension PackageDependency.SourceControl.Requirement: ManifestSyntaxRepresentable {
+    func asSyntax() -> LabeledExprSyntax {
+        switch self {
+        case .exact(let version):
+            LabeledExprSyntax(
+                label: "exact",
+                expression: version.asSyntax()
+            )
+
+        case .range(let range) where range == .upToNextMajor(from: range.lowerBound):
+            LabeledExprSyntax(
+                label: "from",
+                expression: range.lowerBound.asSyntax()
+            )
+
+        case .range(let range):
+            LabeledExprSyntax(
+                expression: "\(range.lowerBound.asSyntax())..<\(range.upperBound.asSyntax())" as ExprSyntax
+            )
+
+        case .revision(let revision):
+            LabeledExprSyntax(
+                label: "revision",
+                expression: "\(literal: revision)" as ExprSyntax
+            )
+
+        case .branch(let branch):
+            LabeledExprSyntax(
+                label: "branch",
+                expression: "\(literal: branch)" as ExprSyntax
+            )
+        }
+    }
+}
+
+extension Version: ManifestSyntaxRepresentable {
+    func asSyntax() -> ExprSyntax {
+        return "\(literal: description)"
     }
 }

Tests/CommandsTests/PackageCommandTests.swift

@@ -813,7 +813,7 @@ final class PackageCommandTests: CommandsTestCase {
             XCTAssertFileExists(manifest)
             let contents: String = try fs.readFileContents(manifest)
 
-            XCTAssertMatch(contents, .contains(#".package(url: "https://github.com/apple/swift-syntax.git", .branch("main")),"#))
+            XCTAssertMatch(contents, .contains(#".package(url: "https://github.com/apple/swift-syntax.git", branch: "main"),"#))
         }
     }
 

Tests/PackageModelSyntaxTests/ManifestEditTests.swift

@@ -16,6 +16,7 @@ import SPMTestSupport
 @_spi(FixItApplier) import SwiftIDEUtils
 import SwiftParser
 import SwiftSyntax
+import struct TSCUtility.Version
 import XCTest
 
 func assertManifestRefactor(
@@ -61,12 +62,17 @@ class ManifestEditTests: XCTestCase {
                 name: "packages",
                 dependencies: [
                   .package(url: "https://github.com/apple/swift-syntax.git", from: "510.0.1"),
-                  .package(url: "https://github.com/apple/swift-system.git", .branch("main")),
+                  .package(url: "https://github.com/apple/swift-system.git", branch: "main"),
                 ]
             )
             """) { manifest in
                 try AddPackageDependency.addPackageDependency(
-                    Self.swiftSystemPackageDependency,
+                    PackageDependency.remoteSourceControl(
+                        identity: PackageIdentity(url: Self.swiftSystemURL),
+                        nameForTargetDependencyResolutionOnly: nil,
+                        url: Self.swiftSystemURL,
+                        requirement: .branch("main"), productFilter: .nothing
+                    ),
                     to: manifest,
                     manifestDirectory: try! AbsolutePath(validating: "/")
                 )
@@ -88,12 +94,18 @@ class ManifestEditTests: XCTestCase {
                 name: "packages",
                 dependencies: [
                   .package(url: "https://github.com/apple/swift-syntax.git", from: "510.0.1"),
-                  .package(url: "https://github.com/apple/swift-system.git", .branch("main")),
+                  .package(url: "https://github.com/apple/swift-system.git", exact: "510.0.0"),
                 ]
             )
             """) { manifest in
                 try AddPackageDependency.addPackageDependency(
-                    Self.swiftSystemPackageDependency,
+                    PackageDependency.remoteSourceControl(
+                        identity: PackageIdentity(url: Self.swiftSystemURL),
+                        nameForTargetDependencyResolutionOnly: nil,
+                        url: Self.swiftSystemURL,
+                        requirement: .exact("510.0.0"),
+                        productFilter: .nothing
+                    ),
                     to: manifest,
                     manifestDirectory: try! AbsolutePath(validating: "/")
                 )
@@ -115,12 +127,20 @@ class ManifestEditTests: XCTestCase {
                 name: "packages",
                 dependencies: [
                   .package(url: "https://github.com/apple/swift-syntax.git", from: "510.0.1"),
-                  .package(url: "https://github.com/apple/swift-system.git", .branch("main")),
+                  .package(url: "https://github.com/apple/swift-system.git", from: "510.0.0"),
                 ] + []
             )
             """) { manifest in
-                try AddPackageDependency.addPackageDependency(
-                    Self.swiftSystemPackageDependency,
+                let versionRange = Range<Version>.upToNextMajor(from: Version(510, 0, 0))
+
+                return try AddPackageDependency.addPackageDependency(
+                    PackageDependency.remoteSourceControl(
+                        identity: PackageIdentity(url: Self.swiftSystemURL),
+                        nameForTargetDependencyResolutionOnly: nil,
+                        url: Self.swiftSystemURL,
+                        requirement: .range(versionRange),
+                        productFilter: .nothing
+                    ),
                     to: manifest,
                     manifestDirectory: try! AbsolutePath(validating: "/")
                 )
@@ -140,12 +160,18 @@ class ManifestEditTests: XCTestCase {
             let package = Package(
                 name: "packages",
                 dependencies: [
-                    .package(url: "https://github.com/apple/swift-system.git", .branch("main")),
+                    .package(url: "https://github.com/apple/swift-system.git", "508.0.0"..<"510.0.0"),
                 ]
             )
             """) { manifest in
             try AddPackageDependency.addPackageDependency(
-                Self.swiftSystemPackageDependency,
+                    PackageDependency.remoteSourceControl(
+                        identity: PackageIdentity(url: Self.swiftSystemURL),
+                        nameForTargetDependencyResolutionOnly: nil,
+                        url: Self.swiftSystemURL,
+                        requirement: .range(Version(508,0,0)..<Version(510,0,0)),
+                        productFilter: .nothing
+                    ),
                 to: manifest,
                 manifestDirectory: try! AbsolutePath(validating: "/")
             )
@@ -164,7 +190,7 @@ class ManifestEditTests: XCTestCase {
             let package = Package(
                 name: "packages",
                 dependencies: [
-                    .package(url: "https://github.com/apple/swift-system.git", .branch("main")),
+                    .package(url: "https://github.com/apple/swift-system.git", branch: "main"),
                 ]
             )
             """) { manifest in
@@ -189,7 +215,7 @@ class ManifestEditTests: XCTestCase {
             let package = Package(
                 name: "packages",
                 dependencies: [
-                    .package(url: "https://github.com/apple/swift-system.git", .branch("main")),
+                    .package(url: "https://github.com/apple/swift-system.git", branch: "main"),
                 ],
                 targets: []
             )