add syncedFolder source type

Author: yonaskolb

Docs/ProjectSpec.md

@@ -153,6 +153,10 @@ Note that target names can also be changed by adding a `name` property to a targ
 - [ ] **postGenCommand**: **String** - A bash command to run after the project has been generated. If the project isn't generated due to no changes when using the cache then this won't run. This is useful for running things like `pod install` only if the project is actually regenerated.
 - [ ] **useBaseInternationalization**: **Bool** If this is `false` and your project does not include resources located in a **Base.lproj** directory then `Base` will not be included in the projects 'known regions'. The default value is `true`. 
 - [ ] **schemePathPrefix**: **String** - A path prefix for relative paths in schemes, such as StoreKitConfiguration. The default is `"../../"`, which is suitable for non-workspace projects. For use in workspaces, use `"../"`.
+- [ ] **defaultSourceDirectoryType**: **String** - When a [Target source](#target-source) doesn't specify a type and is a directory, this is the type that will be used. If nothing is specified for either then `group` will be used.
+  - `group` (default)
+  - `folder`
+  - `syncedFolder`
 
 ```yaml
 options:
@@ -542,6 +546,7 @@ A source can be provided via a string (the path) or an object of the form:
 	- `file`: a file reference with a parent group will be created (Default for files or directories with extensions)
 	- `group`: a group with all it's containing files. (Default for directories without extensions)
 	- `folder`: a folder reference.
+	- `syncedFolder`: Xcode 16's synchronized folders, also knows as buildable folders
 - [ ] **headerVisibility**: **String** - The visibility of any headers. This defaults to `public`, but can be either:
 	- `public`
 	- `private`

Sources/ProjectSpec/SourceType.swift

@@ -11,4 +11,5 @@ public enum SourceType: String {
     case group
     case file
     case folder
+    case syncedFolder
 }

Sources/ProjectSpec/SpecOptions.swift

@@ -37,6 +37,7 @@ public struct SpecOptions: Equatable {
     public var postGenCommand: String?
     public var useBaseInternationalization: Bool
     public var schemePathPrefix: String
+    public var defaultSourceDirectoryType: SourceType?
 
     public enum ValidationType: String {
         case missingConfigs
@@ -100,7 +101,8 @@ public struct SpecOptions: Equatable {
         preGenCommand: String? = nil,
         postGenCommand: String? = nil,
         useBaseInternationalization: Bool = useBaseInternationalizationDefault,
-        schemePathPrefix: String = schemePathPrefixDefault
+        schemePathPrefix: String = schemePathPrefixDefault,
+        defaultSourceDirectoryType: SourceType? = nil
     ) {
         self.minimumXcodeGenVersion = minimumXcodeGenVersion
         self.carthageBuildPath = carthageBuildPath
@@ -127,6 +129,7 @@ public struct SpecOptions: Equatable {
         self.postGenCommand = postGenCommand
         self.useBaseInternationalization = useBaseInternationalization
         self.schemePathPrefix = schemePathPrefix
+        self.defaultSourceDirectoryType = defaultSourceDirectoryType
     }
 }
 
@@ -160,6 +163,7 @@ extension SpecOptions: JSONObjectConvertible {
         postGenCommand = jsonDictionary.json(atKeyPath: "postGenCommand")
         useBaseInternationalization = jsonDictionary.json(atKeyPath: "useBaseInternationalization") ?? SpecOptions.useBaseInternationalizationDefault
         schemePathPrefix = jsonDictionary.json(atKeyPath: "schemePathPrefix") ?? SpecOptions.schemePathPrefixDefault
+        defaultSourceDirectoryType = jsonDictionary.json(atKeyPath: "defaultSourceDirectoryType")
         if jsonDictionary["fileTypes"] != nil {
             fileTypes = try jsonDictionary.json(atKeyPath: "fileTypes")
         } else {

Sources/XcodeGenKit/PBXProjGenerator.swift

@@ -1454,6 +1454,12 @@ public class PBXProjGenerator {
         if !target.isLegacy {
             targetObject.productType = target.type
         }
+
+        // add fileSystemSynchronizedGroups
+        let synchronizedRootGroups = sourceFiles.compactMap { $0.synchronizedRootGroup }
+        if !synchronizedRootGroups.isEmpty {
+            targetObject.fileSystemSynchronizedGroups = synchronizedRootGroups
+        }
     }
 
     private func makePlatformFilter(for filter: Dependency.PlatformFilter) -> String? {

Sources/XcodeGenKit/SourceGenerator.swift

@@ -9,6 +9,7 @@ struct SourceFile {
     let fileReference: PBXFileElement
     let buildFile: PBXBuildFile
     let buildPhase: BuildPhaseSpec?
+    var synchronizedRootGroup: PBXFileSystemSynchronizedRootGroup?
 }
 
 class SourceGenerator {
@@ -687,6 +688,33 @@ class SourceGenerator {
 
             sourceFiles += groupSourceFiles
             sourceReference = group
+        case .syncedFolder:
+
+            let relativePath = (try? path.relativePath(from: project.basePath)) ?? path
+
+            let syncedRootGroup = PBXFileSystemSynchronizedRootGroup(
+                sourceTree: .group,
+                path: relativePath.string,
+                name: targetSource.name,
+                explicitFileTypes: [:],
+                exceptions: [],
+                explicitFolders: []
+            )
+            addObject(syncedRootGroup)
+            sourceReference = syncedRootGroup
+
+            // TODO: adjust if hasCustomParent == true
+            rootGroups.insert(syncedRootGroup)
+
+            var sourceFile = generateSourceFile(
+                targetType: targetType,
+                targetSource: targetSource,
+                path: path,
+                fileReference: syncedRootGroup,
+                buildPhases: buildPhases
+            )
+            sourceFile.synchronizedRootGroup = syncedRootGroup
+            sourceFiles.append(sourceFile)
         }
 
         if hasCustomParent {
@@ -703,7 +731,17 @@ class SourceGenerator {
     ///
     /// While `TargetSource` declares `type`, its optional and in the event that the value is not defined then we must resolve a sensible default based on the path of the source.
     private func resolvedTargetSourceType(for targetSource: TargetSource, at path: Path) -> SourceType {
-        return targetSource.type ?? (path.isFile || path.extension != nil ? .file : .group)
+        if let chosenType = targetSource.type {
+            return chosenType
+        } else {
+            if path.isFile || path.extension != nil {
+                return .file
+            } else if let sourceType = project.options.defaultSourceDirectoryType {
+                return sourceType
+            } else {
+                return .group
+            }
+        }
     }
 
     private func createParentGroups(_ parentGroups: [String], for fileElement: PBXFileElement) {

Sources/XcodeGenKit/XCProjExtensions.swift

@@ -38,6 +38,8 @@ extension PBXProj {
                 string += "\n 🌎 " + variantGroup.nameOrPath
             } else if let versionGroup = child as? XCVersionGroup {
                 string += "\n 🔢 " + versionGroup.nameOrPath
+            } else if let syncedFolder = child as? PBXFileSystemSynchronizedRootGroup {
+                string += "\n 📁 " + syncedFolder.nameOrPath
             }
         }
         return string

Tests/Fixtures/TestProject/App_iOS/AppDelegate.swift

@@ -7,10 +7,16 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     var window: UIWindow?
 
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
-        // Override point for customization after application launch.
+
+        // file from a framework
         _ = FrameworkStruct()
+
         // Standalone files added to project by path-to-file.
         _ = standaloneHello()
+
+        // file in a synced folder
+        _ = SyncedStruct()
+
         return true
     }
 }

Tests/Fixtures/TestProject/Project.xcodeproj/project.pbxproj

@@ -830,6 +830,18 @@
 		FED40A89162E446494DDE7C7 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist; path = Info.plist; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
+/* Begin PBXFileSystemSynchronizedRootGroup section */
+		AE2AB2772F70DFFF402AA02B /* SyncedFolder */ = {
+			isa = PBXFileSystemSynchronizedRootGroup;
+			explicitFileTypes = {
+			};
+			explicitFolders = (
+			);
+			path = SyncedFolder;
+			sourceTree = "<group>";
+		};
+/* End PBXFileSystemSynchronizedRootGroup section */
+
 /* Begin PBXFrameworksBuildPhase section */
 		117840B4DBC04099F6779D00 /* Frameworks */ = {
 			isa = PBXFrameworksBuildPhase;
@@ -1050,6 +1062,7 @@
 				2E1E747C7BC434ADB80CC269 /* Headers */,
 				6B1603BA83AA0C7B94E45168 /* ResourceFolder */,
 				6BBE762F36D94AB6FFBFE834 /* SomeFile */,
+				AE2AB2772F70DFFF402AA02B /* SyncedFolder */,
 				79DC4A1E4D2E0D3A215179BC /* Bundles */,
 				FC1515684236259C50A7747F /* Frameworks */,
 				AC523591AC7BE9275003D2DB /* Products */,
@@ -1686,6 +1699,9 @@
 				E8C078B0A2A2B0E1D35694D5 /* PBXTargetDependency */,
 				981D116D40DBA0407D0E0E94 /* PBXTargetDependency */,
 			);
+			fileSystemSynchronizedGroups = (
+				AE2AB2772F70DFFF402AA02B /* SyncedFolder */,
+			);
 			name = App_iOS;
 			packageProductDependencies = (
 				D7917D10F77DA9D69937D493 /* Swinject */,

Tests/Fixtures/TestProject/SyncedFolder/SyncedFile.swift

@@ -0,0 +1,4 @@
+
+struct SyncedStruct {
+  
+}

Tests/Fixtures/TestProject/project.yml

@@ -164,6 +164,8 @@ targets:
           - tag1
           - tag2
       - String Catalogs/LocalizableStrings.xcstrings
+      - path: SyncedFolder
+        type: syncedFolder
     settings:
       INFOPLIST_FILE: App_iOS/Info.plist
       PRODUCT_BUNDLE_IDENTIFIER: com.project.app

Tests/XcodeGenKitTests/SourceGeneratorTests.swift

@@ -84,6 +84,42 @@ class SourceGeneratorTests: XCTestCase {
                 try pbxProj.expectFile(paths: ["Sources", "A", "C2.0", "c.swift"], buildPhase: .sources)
             }
 
+            $0.it("generates synced folder") {
+                let directories = """
+                Sources:
+                  A:
+                    - a.swift
+                """
+                try createDirectories(directories)
+
+                let target = Target(name: "Test", type: .application, platform: .iOS, sources: [.init(path: "Sources", type: .syncedFolder)])
+                let project = Project(basePath: directoryPath, name: "Test", targets: [target])
+
+                let pbxProj = try project.generatePbxProj()
+                let syncedFolders = try pbxProj.getMainGroup().children.compactMap { $0 as? PBXFileSystemSynchronizedRootGroup }
+                let syncedFolder = try unwrap(syncedFolders.first)
+
+                try expect([syncedFolder]) == pbxProj.nativeTargets.first?.fileSystemSynchronizedGroups
+            }
+
+            $0.it("respects defaultSourceDirectoryType") {
+                let directories = """
+                Sources:
+                  A:
+                    - a.swift
+                """
+                try createDirectories(directories)
+
+                let target = Target(name: "Test", type: .application, platform: .iOS, sources: ["Sources"])
+                let project = Project(basePath: directoryPath, name: "Test", targets: [target], options: .init(defaultSourceDirectoryType: .syncedFolder))
+
+                let pbxProj = try project.generatePbxProj()
+                let syncedFolders = try pbxProj.getMainGroup().children.compactMap { $0 as? PBXFileSystemSynchronizedRootGroup }
+                let syncedFolder = try unwrap(syncedFolders.first)
+
+                try expect([syncedFolder]) == pbxProj.nativeTargets.first?.fileSystemSynchronizedGroups
+            }
+
             $0.it("supports frameworks in sources") {
                 let directories = """
                 Sources: