fix: Inconsistent behaviour with Xcode 16 when PBXProject.TargetAttributes is empty (#865)

* remove empty TargetAttributes from result pbxproj as Xcode 16 do each run

* Add tests

* Fix the tests on Linux

* Some fixes

* Lint fixes

* Use Swift 5.10.0

* Don't virtualize on CI

* Fix tests on Linux

* Not select Xcode

* Fix linting issue

* Fix tests on linux

---------

Co-authored-by: Maxim Kholyavkin <[email protected]>
Co-authored-by: Pedro <[email protected]>

Author: 3 people

.all-contributorsrc

@@ -383,6 +383,7 @@
         "code"
       ]
     },
+    {
       "login": "georgenavarro",
       "name": "George Navarro",
       "avatar_url": "https://avatars.githubusercontent.com/u/2748028?v=4",

.github/workflows/xcodeproj.yml

@@ -20,8 +20,6 @@ jobs:
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Select Xcode 16
-        run: sudo xcode-select -switch /Applications/Xcode_16.app/Contents/Developer
       - uses: jdx/mise-action@v2
       - name: Build
         run: mise run build
@@ -31,15 +29,14 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: jdx/mise-action@v2
+      - uses: swift-actions/setup-swift@v2
       - name: Build
-        run: mise run build-linux
+        run: swift build --configuration release
   test:
     name: Test (macOS / Xcode)
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Select Xcode 16
-        run: sudo xcode-select -switch /Applications/Xcode_16.app/Contents/Developer
       - uses: jdx/mise-action@v2
       - name: Run tests
         run: mise run test
@@ -50,15 +47,18 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: jdx/mise-action@v2
+      - uses: swift-actions/setup-swift@v2
+      - run: |
+          git config --global user.email '[email protected]'
+          git config --global user.name 'xcodeproj'
+          git config --global init.defaultBranch main
       - name: Test
-        run: mise run test-linux
+        run: swift test
 
   lint:
     name: Lint
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Select Xcode 16
-        run: sudo xcode-select -switch /Applications/Xcode_16.app/Contents/Developer
       - uses: jdx/mise-action@v2
       - run: mise run lint

.mise/tasks/test-linux

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 # mise description="Run tests on Linux"
 
-CONTAINER_RUNTIME=$(command -v podman || command -v docker)
+CONTAINER_RUNTIME=docker
 
 if [ -z "$CONTAINER_RUNTIME" ]; then
   echo "Neither podman nor docker is available. Please install one to proceed."

.swift-version

@@ -1 +1 @@
-5.7.1
+5.10

Package.resolved

@@ -1,4 +1,4 @@
-// swift-tools-version:5.8
+// swift-tools-version:5.10.0
 
 import PackageDescription
 
@@ -10,7 +10,6 @@ let package = Package(
     dependencies: [
         .package(url: "https://github.com/tadija/AEXML.git", .upToNextMinor(from: "4.6.1")),
         .package(url: "https://github.com/kylef/PathKit.git", .upToNextMinor(from: "1.0.1")),
-        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.4.3"),
     ],
     targets: [
         .target(name: "XcodeProj",

Package.swift

@@ -16,11 +16,11 @@ public enum XCodeProjError: Error, CustomStringConvertible, Sendable {
     public var description: String {
         switch self {
         case let .notFound(path):
-            return "The project cannot be found at \(path.string)"
+            "The project cannot be found at \(path.string)"
         case let .pbxprojNotFound(path):
-            return "The project doesn't contain a .pbxproj file at path: \(path.string)"
+            "The project doesn't contain a .pbxproj file at path: \(path.string)"
         case let .xcworkspaceNotFound(path):
-            return "The project doesn't contain a .xcworkspace at path: \(path.string)"
+            "The project doesn't contain a .xcworkspace at path: \(path.string)"
         }
     }
 }
@@ -36,7 +36,7 @@ public enum XCSharedDataError: Error, CustomStringConvertible {
     public var description: String {
         switch self {
         case let .notFound(path):
-            return "xcshareddata not found at path \(path.string)"
+            "xcshareddata not found at path \(path.string)"
         }
     }
 }
@@ -52,7 +52,7 @@ public enum XCUserDataError: Error, CustomStringConvertible {
     public var description: String {
         switch self {
         case let .notFound(path):
-            return "xcuserdata not found at path \(path.string)"
+            "xcuserdata not found at path \(path.string)"
         }
     }
 }
@@ -68,7 +68,7 @@ public enum XCWorkspaceError: Error, CustomStringConvertible {
     public var description: String {
         switch self {
         case let .notFound(path):
-            return "The project cannot be found at \(path.string)"
+            "The project cannot be found at \(path.string)"
         }
     }
 }
@@ -84,7 +84,7 @@ public enum XCWorkspaceDataError: Error, CustomStringConvertible {
     public var description: String {
         switch self {
         case let .notFound(path):
-            return "Workspace not found at \(path.string)"
+            "Workspace not found at \(path.string)"
         }
     }
 }
@@ -100,7 +100,7 @@ public enum XcodeprojEditingError: Error, CustomStringConvertible {
     public var description: String {
         switch self {
         case let .unexistingFile(path):
-            return "The file at path \(path.string) doesn't exist"
+            "The file at path \(path.string) doesn't exist"
         }
     }
 }
@@ -116,7 +116,7 @@ public enum XcodeprojWritingError: Error, CustomStringConvertible {
     public var description: String {
         switch self {
         case let .invalidType(classType, expected):
-            return "Invalid type for object \(classType) that expects a \(expected)"
+            "Invalid type for object \(classType) that expects a \(expected)"
         }
     }
 }
@@ -140,15 +140,15 @@ public enum PBXObjectError: Error, CustomStringConvertible {
     public var description: String {
         switch self {
         case .missingIsa:
-            return "Isa property is missing."
+            "Isa property is missing."
         case let .unknownElement(element):
-            return "The element \(element) is not supported."
+            "The element \(element) is not supported."
         case .objectsReleased:
-            return "The PBXObjects instance has been released before saving."
+            "The PBXObjects instance has been released before saving."
         case let .objectNotFound(reference):
-            return "PBXObject with reference \"\(reference)\" not found."
+            "PBXObject with reference \"\(reference)\" not found."
         case let .orphaned(type, reference):
-            return "Trying to use object \(type) with reference '\(reference)' before being added to any project"
+            "Trying to use object \(type) with reference '\(reference)' before being added to any project"
         }
     }
 }
@@ -164,7 +164,7 @@ enum PBXProjEncoderError: Error, CustomStringConvertible {
     var description: String {
         switch self {
         case .emptyProjectReference:
-            return "PBXProj should contain a reference to the XcodeProj object that represents the project"
+            "PBXProj should contain a reference to the XcodeProj object that represents the project"
         }
     }
 }
@@ -187,23 +187,23 @@ enum PBXProjError: Error, CustomStringConvertible, Equatable {
     var description: String {
         switch self {
         case let .notFound(path):
-            return ".pbxproj not found at path \(path.string)"
+            ".pbxproj not found at path \(path.string)"
         case let .invalidGroupPath(sourceRoot, elementPath):
-            return "Cannot calculate full path for file element \"\(elementPath ?? "")\" in source root: \"\(sourceRoot)\""
+            "Cannot calculate full path for file element \"\(elementPath ?? "")\" in source root: \"\(sourceRoot)\""
         case let .targetNotFound(targetName):
-            return "Could not find target with \(targetName)"
+            "Could not find target with \(targetName)"
         case let .frameworksBuildPhaseNotFound(targetName):
-            return "Could not find frameworks build phase for target \(targetName)"
+            "Could not find frameworks build phase for target \(targetName)"
         case let .sourcesBuildPhaseNotFound(targetName):
-            return "Could not find sources build phase for target \(targetName)"
+            "Could not find sources build phase for target \(targetName)"
         case let .pathIsAbsolute(path):
-            return "Path must be relative, but path \(path.string) is absolute"
+            "Path must be relative, but path \(path.string) is absolute"
         case let .multipleLocalPackages(productName: productName):
-            return "Found multiple top-level packages named \(productName)"
+            "Found multiple top-level packages named \(productName)"
         case let .multipleRemotePackages(productName: productName):
-            return "Can not resolve dependency \(productName) - conflicting version requirements"
+            "Can not resolve dependency \(productName) - conflicting version requirements"
         case .malformed:
-            return "The .pbxproj is malformed."
+            "The .pbxproj is malformed."
         }
     }
 }
@@ -221,9 +221,9 @@ public enum XCBreakpointListError: Error, CustomStringConvertible {
     public var description: String {
         switch self {
         case let .notFound(path):
-            return "Breakpoints_v2.xcbkptlist couldn't be found at path \(path.string)"
+            "Breakpoints_v2.xcbkptlist couldn't be found at path \(path.string)"
         case let .missing(property):
-            return "Property \(property) missing"
+            "Property \(property) missing"
         }
     }
 }
@@ -238,7 +238,7 @@ public enum XCConfigError: Error, CustomStringConvertible {
     public var description: String {
         switch self {
         case let .notFound(path):
-            return ".xcconfig file not found at \(path.string)"
+            ".xcconfig file not found at \(path.string)"
         }
     }
 }

Sources/XcodeProj/Errors/Errors.swift

@@ -11,15 +11,15 @@ extension KeyedDecodingContainer {
 
     func decodeIntIfPresent(_ key: KeyedDecodingContainer.Key) throws -> UInt? {
         if let string: String = try? decodeIfPresent(key) {
-            return UInt(string)
+            UInt(string)
         } else if let bool: Bool = try? decodeIfPresent(key) {
-            return bool ? 0 : 1
+            bool ? 0 : 1
         } else if let int: UInt = try decodeIfPresent(key) {
             // don't `try?` here in case key _does_ exist but isn't an expected type
             // ie. not a string/bool/int
-            return int
+            int
         } else {
-            return nil
+            nil
         }
     }
 

Sources/XcodeProj/Extensions/KeyedDecodingContainer+Additions.swift

@@ -20,20 +20,20 @@ public final class PBXContainerItemProxy: PBXObject {
 
         var uuid: String {
             switch self {
-            case let .reference(reference): return reference.value
-            case let .string(string): return string
+            case let .reference(reference): reference.value
+            case let .string(string): string
             }
         }
 
         var id: RemoteGlobalID {
             switch self {
             case let .reference(reference):
                 if let object = reference.getObject() {
-                    return .object(object)
+                    .object(object)
                 } else {
-                    return .string(reference.value)
+                    .string(reference.value)
                 }
-            case let .string(string): return .string(string)
+            case let .string(string): .string(string)
             }
         }
     }
@@ -44,15 +44,15 @@ public final class PBXContainerItemProxy: PBXObject {
 
         var uuid: String {
             switch self {
-            case let .object(object): return object.uuid
-            case let .string(string): return string
+            case let .object(object): object.uuid
+            case let .string(string): string
             }
         }
 
         var reference: RemoteGlobalIDReference {
             switch self {
-            case let .object(object): return .reference(object.reference)
-            case let .string(string): return .string(string)
+            case let .object(object): .reference(object.reference)
+            case let .string(string): .string(string)
             }
         }
     }
@@ -185,11 +185,11 @@ private extension PBXContainerItemProxy.ContainerPortal {
     var reference: PBXObjectReference? {
         switch self {
         case let .project(project):
-            return project.reference
+            project.reference
         case let .fileReference(fileReference):
-            return fileReference.reference
+            fileReference.reference
         case .unknownObject:
-            return nil
+            nil
         }
     }
 

Sources/XcodeProj/Objects/Files/PBXContainerItemProxy.swift

@@ -215,18 +215,17 @@ public extension PBXGroup {
             return existingFileReference.value
         }
 
-        let path: String?
-        switch sourceTree {
+        let path: String? = switch sourceTree {
         case .group:
-            path = groupPath.map { filePath.relative(to: $0) }?.string
+            groupPath.map { filePath.relative(to: $0) }?.string
         case .sourceRoot:
-            path = filePath.relative(to: sourceRoot).string
+            filePath.relative(to: sourceRoot).string
         case .absolute,
              .sdkRoot,
              .developerDir:
-            path = filePath.string
+            filePath.string
         default:
-            path = nil
+            nil
         }
         let fileReference = PBXFileReference(
             sourceTree: sourceTree,