Add support for SwiftPM node in project file

Author: phimage

.swift-version

@@ -32,6 +32,8 @@ public enum Isa: String, CaseIterable, CustomStringConvertible {
     case versionGroup = "XCVersionGroup"
     case configurationList = "XCConfigurationList"
     case buildConfiguration = "XCBuildConfiguration"
+    case remoteSwiftPackageReference = "XCRemoteSwiftPackageReference"
+    case swiftPackageProductDependency = "XCSwiftPackageProductDependency"
 
     public var description: String {
         return rawValue
@@ -79,6 +81,8 @@ extension Isa {
         case .versionGroup: return XCVersionGroup.self
         case .configurationList: return XCConfigurationList.self
         case .buildConfiguration: return XCBuildConfiguration.self
+        case .remoteSwiftPackageReference: return XCRemoteSwiftPackageReference.self
+        case .swiftPackageProductDependency: return XCSwiftPackageProductDependency.self
         }
     }
 }

Sources/Isa.swift

@@ -12,14 +12,17 @@ public class PBXBuildFile: PBXProjectItem {
 
     public enum PBXKeys: PBXKey {
         case fileRef
+        case productRef
         case settings
     }
 
     #if LAZY
     public lazy var fileRef: PBXReference? = self.object(PBXKeys.fileRef)
+    public lazy var productRef: XCSwiftPackageProductDependency? = self.object(PBXKeys.productRef)
     public lazy var settings: [String: Any]? = self.dictionary(PBXKeys.settings)
     #else
     public var fileRef: PBXReference? { self.object(PBXKeys.fileRef) }
+    public var productRef: XCSwiftPackageProductDependency? { self.object(PBXKeys.productRef) }
     public var settings: [String: Any]? { self.dictionary(PBXKeys.settings) }
     #endif
 

Sources/PBXBuildFile.swift

@@ -17,6 +17,7 @@ public class PBXProject: PBXContainer, PBXBuildConfigurationListable {
         case targets
         case mainGroup
         case buildConfigurationList
+        case packageReferences
     }
 
     #if LAZY
@@ -26,6 +27,7 @@ public class PBXProject: PBXContainer, PBXBuildConfigurationListable {
     public lazy var targets: [PBXNativeTarget] = self.objects(PBXKeys.targets)
     public lazy var mainGroup: PBXGroup? = self.object(.mainGroup)
     public lazy var buildConfigurationList: XCConfigurationList? = self.object(PBXKeys.buildConfigurationList)
+    public lazy var packageReferences: [XCRemoteSwiftPackageReference] = self.objects(PBXKeys.packageReferences)
 
     lazy var targetsByConfigRef: [String: PBXNativeTarget] = {
         var dict: [String: PBXNativeTarget] = [:]
@@ -43,6 +45,7 @@ public class PBXProject: PBXContainer, PBXBuildConfigurationListable {
     public var targets: [PBXNativeTarget] { self.objects(PBXKeys.targets) }
     public var mainGroup: PBXGroup? { self.object(PBXKeys.mainGroup) }
     public var buildConfigurationList: XCConfigurationList? { self.object(PBXKeys.buildConfigurationList) }
+    public var packageReferences: [XCRemoteSwiftPackageReference] { self.objects(PBXKeys.packageReferences) }
 
     var targetsByConfigRef: [String: PBXNativeTarget] {
         var dict: [String: PBXNativeTarget] = [:]
@@ -84,11 +87,11 @@ extension PBXProject {
     }
 
     public struct Version: Comparable, CustomStringConvertible {
-    
+
         public var major: Int
         public var minor: Int
 
-        public init?(_ string: String?){
+        public init?(_ string: String?) {
             guard let string = string, string.count > 3 else {
                 return nil
             }
@@ -101,7 +104,7 @@ extension PBXProject {
             self.minor = minor
         }
 
-        public init(major: Int, minor: Int){
+        public init(major: Int, minor: Int) {
             self.major = major
             self.minor = minor
         }
@@ -125,7 +128,7 @@ extension PBXProject {
         }
 
         public var openStep: String {
-            return "\(String(format: "%02d", self.major))\(String(format: "%02d",self.minor))"
+            return "\(String(format: "%02d", self.major))\(String(format: "%02d", self.minor))"
         }
     }
 

Sources/PBXProject.swift

@@ -16,6 +16,7 @@ public /* abstract */ class PBXTarget: PBXProjectItem, PBXBuildConfigurationList
         case buildPhases
         case buildConfigurationList
         case dependencies
+        case packageProductDependencies
     }
 
     #if LAZY
@@ -24,12 +25,14 @@ public /* abstract */ class PBXTarget: PBXProjectItem, PBXBuildConfigurationList
     public lazy var buildPhases: [PBXBuildPhase] = self.objects(PBXKeys.buildPhases)
     public lazy var buildConfigurationList: XCConfigurationList? = self.object(PBXKeys.buildConfigurationList)
     public lazy var dependencies: [PBXTargetDependency] = self.objects(PBXKeys.dependencies)
+    public lazy var packageProductDependencies: [XCSwiftPackageProductDependency] = self.objects(PBXKeys.packageProductDependencies) // swiftlint:disable:this line_length
     #else
     public var name: String { self.string(PBXKeys.name) }
     public var productName: String? { self.string(PBXKeys.productName) }
     public var buildPhases: [PBXBuildPhase] { self.objects(PBXKeys.buildPhases) }
     public var buildConfigurationList: XCConfigurationList? { self.object(PBXKeys.buildConfigurationList) }
     public var dependencies: [PBXTargetDependency] { self.objects(PBXKeys.dependencies) }
+    public var packageProductDependencies: [XCSwiftPackageProductDependency] {self.objects(PBXKeys.packageProductDependencies) } // swiftlint:disable:this line_length
     #endif
 
     public override var comment: String? {

Sources/PBXTarget.swift

@@ -8,7 +8,7 @@
 
 import Foundation
 
-//swiftlint:disable:next force_try
+// swiftlint:disable:next force_try
 let nonescapeRegex = try! NSRegularExpression(pattern: "^[a-z0-9_\\$\\.\\/]+$", options: .caseInsensitive)
 let specialRegexes: [(String, NSRegularExpression)] = ["\\\\", "\\\"", "\\n", "\\r", "\\t"].compactMap { string in
     if let regular = try? NSRegularExpression(pattern: string, options: []) {

Sources/String+XcodeProjKit.swift

@@ -0,0 +1,26 @@
+//
+//  XCRemoteSwiftPackageReference.swift
+//  XcodeProjKit
+//
+//  Created by emarchand on 29/05/2021.
+//  Copyright © 2021 AnOrgaName. All rights reserved.
+//
+
+import Foundation
+
+public class XCRemoteSwiftPackageReference: PBXObject {
+
+    public enum PBXKeys: PBXKey {
+        case repositoryURL
+        case requirement
+    }
+
+    #if LAZY
+    public lazy var repositoryURL: String? = self.string(PBXKeys.repositoryURL)
+    public lazy var requirement: [String: Any]? = dictionary(PBXKeys.requirement)
+    #else
+    public var repositoryURL: String? { self.string(PBXKeys.repositoryURL) }
+    public var requirement: [String: Any]? { dictionary(PBXKeys.requirement) }
+    #endif
+
+}

Sources/XCRemoteSwiftPackageReference.swift

@@ -0,0 +1,26 @@
+//
+//  XCSwiftPackageProductDependency.swift
+//  XcodeProjKit
+//
+//  Created by emarchand on 29/05/2021.
+//  Copyright © 2021 AnOrgaName. All rights reserved.
+//
+
+import Foundation
+
+public class XCSwiftPackageProductDependency: PBXObject {
+
+    public enum PBXKeys: PBXKey {
+        case productName
+        case package
+    }
+
+    #if LAZY
+    public lazy var productName: String? = self.string(PBXKeys.productName)
+    public lazy var package: XCRemoteSwiftPackageReference? = self.object(PBXKeys.productName)
+    #else
+    public var productName: String? { self.string(PBXKeys.productName) } // but not ""
+    public var package: XCRemoteSwiftPackageReference? { self.object(PBXKeys.productName) }
+    #endif
+
+}

Sources/XCSwiftPackageProductDependency.swift

@@ -173,7 +173,7 @@ public class XcodeProj {
 }
 
 let extractProjetName = "Build configuration list for PBXProject \""
-//swiftlint:disable:next force_try
+// swiftlint:disable:next force_try
 let extractProjetNameRegex = try! NSRegularExpression(pattern:
     "Build configuration list for PBXProject \"(.*)\"", options: [])
 

Sources/XcodeProj.swift

@@ -87,19 +87,28 @@ class XcodeProjKitParseTests: XCTestCase {
     func testplist() {
         testParse("ok/plist")
     }
-    
-    func testParse(_ resource: String) {
+
+    func testswiftpm() {
+        let proj = testParse("ok/swiftpm.project")
+        XCTAssertNotNil(proj?.objects.object("48A408192662576D0068A35B"))
+        XCTAssertNotNil(proj?.objects.object("48A4081A2662576D0068A35B"))
+    }
+
+    @discardableResult
+    func testParse(_ resource: String) -> XcodeProj? {
         if let url = url(forResource: resource, withExtension: XcodeProj.pbxprojFileExtension) {
             do {
                 let proj = try XcodeProj(url: url)
                 XCTAssertNotNil(proj.project.mainGroup)
                 XCTAssertNotNil(proj.project.buildConfigurationList)
+                return proj
             } catch {
                 XCTFail("\(error)")
             }
         } else {
             XCTFail("Missing resource \(resource)")
         }
+        return nil
     }
 
 }