Merge branch 'master' into scheme_asan_options

Author: yonaskolb

CHANGELOG.md

@@ -2,7 +2,11 @@
 
 ## Next Version
 
-- Added Address Sanitizer & similar options in run/test schemes #1550 @hi-kumar
+### Added
+- Added sanitizer options to run and test actions in Scheme #1550 @hi-kumar
+
+### Fixed
+- Added validation to ensure that all values in `settings.configs` are mappings. Previously, passing non-mapping values did not raise an error, making it difficult to detect misconfigurations. Now, `SpecParsingError.invalidConfigsMappingFormat` is thrown if misused. #1547 @Ryu0118
 
 ## 2.43.0
 

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`

Package.resolved

@@ -16,7 +16,7 @@ let package = Package(
         .package(url: "https://github.com/yonaskolb/JSONUtilities.git", from: "4.2.0"),
         .package(url: "https://github.com/kylef/Spectre.git", from: "0.9.2"),
         .package(url: "https://github.com/onevcat/Rainbow.git", from: "4.0.0"),
-        .package(url: "https://github.com/tuist/XcodeProj.git", exact: "8.24.3"),
+        .package(url: "https://github.com/tuist/XcodeProj.git", exact: "8.27.7"),
         .package(url: "https://github.com/jakeheis/SwiftCLI.git", from: "6.0.3"),
         .package(url: "https://github.com/mxcl/Version", from: "2.0.0"),
         .package(url: "https://github.com/freddi-kit/ArtifactBundleGen", exact: "0.0.6")

Package.swift

@@ -60,7 +60,7 @@ extension AggregateTarget: NamedJSONDictionaryConvertible {
     public init(name: String, jsonDictionary: JSONDictionary) throws {
         self.name = jsonDictionary.json(atKeyPath: "name") ?? name
         targets = jsonDictionary.json(atKeyPath: "targets") ?? []
-        settings = jsonDictionary.json(atKeyPath: "settings") ?? .empty
+        settings = try BuildSettingsParser(jsonDictionary: jsonDictionary).parse()
         configFiles = jsonDictionary.json(atKeyPath: "configFiles") ?? [:]
         buildScripts = jsonDictionary.json(atKeyPath: "buildScripts") ?? []
         buildToolPlugins = jsonDictionary.json(atKeyPath: "buildToolPlugins") ?? []

Sources/ProjectSpec/AggregateTarget.swift

@@ -0,0 +1,37 @@
+import Foundation
+import JSONUtilities
+
+/// A helper for extracting and validating the `Settings` object from a JSON dictionary.
+struct BuildSettingsParser {
+    let jsonDictionary: JSONDictionary
+
+    /// Attempts to extract and parse the `Settings` from the dictionary.
+    ///
+    /// - Returns: A valid `Settings` object
+    func parse() throws -> Settings {
+        do {
+            return try jsonDictionary.json(atKeyPath: "settings")
+        } catch let specParsingError as SpecParsingError {
+            // Re-throw `SpecParsingError` to prevent the misuse of settings.configs.
+            throw specParsingError
+        } catch {
+            // Ignore all errors except `SpecParsingError`
+            return .empty
+        }
+    }
+
+    /// Attempts to extract and parse setting groups from the dictionary with fallback defaults.
+    ///
+    /// - Returns: Parsed setting groups or default groups if parsing fails
+    func parseSettingGroups() throws -> [String: Settings] {
+        do {
+            return try jsonDictionary.json(atKeyPath: "settingGroups", invalidItemBehaviour: .fail)
+        } catch let specParsingError as SpecParsingError {
+            // Re-throw `SpecParsingError` to prevent the misuse of settingGroups.
+            throw specParsingError
+        } catch {
+            // Ignore all errors except `SpecParsingError`
+            return jsonDictionary.json(atKeyPath: "settingPresets") ?? [:]
+        }
+    }
+}

Sources/ProjectSpec/BuildSettingsExtractor.swift

@@ -10,7 +10,7 @@ public class CacheFile {
 
         guard #available(OSX 10.13, *) else { return nil }
 
-        let files = Set(project.allFiles)
+        let files = Set(project.allTrackedFiles)
             .map { ((try? $0.relativePath(from: project.basePath)) ?? $0).string }
             .sorted { $0.localizedStandardCompare($1) == .orderedAscending }
             .joined(separator: "\n")

Sources/ProjectSpec/CacheFile.swift

@@ -171,11 +171,13 @@ extension Project {
         self.basePath = basePath
 
         let jsonDictionary = Project.resolveProject(jsonDictionary: jsonDictionary)
+        let buildSettingsParser = BuildSettingsParser(jsonDictionary: jsonDictionary)
 
         name = try jsonDictionary.json(atKeyPath: "name")
-        settings = jsonDictionary.json(atKeyPath: "settings") ?? .empty
-        settingGroups = jsonDictionary.json(atKeyPath: "settingGroups")
-            ?? jsonDictionary.json(atKeyPath: "settingPresets") ?? [:]
+
+        settings = try buildSettingsParser.parse()
+        settingGroups = try buildSettingsParser.parseSettingGroups()
+
         let configs: [String: String] = jsonDictionary.json(atKeyPath: "configs") ?? [:]
         self.configs = configs.isEmpty ? Config.defaultConfigs :
             configs.map { Config(name: $0, type: ConfigType(rawValue: $1)) }.sorted { $0.name < $1.name }
@@ -250,7 +252,7 @@ extension Project: PathContainer {
 
 extension Project {
 
-    public var allFiles: [Path] {
+    public var allTrackedFiles: [Path] {
         var files: [Path] = []
         files.append(contentsOf: configFilePaths)
         for fileGroup in fileGroups {
@@ -268,15 +270,31 @@ extension Project {
             files.append(contentsOf: target.configFilePaths)
             for source in target.sources {
                 let sourcePath = basePath + source.path
-                let sourceChildren = (try? sourcePath.recursiveChildren()) ?? []
-                files.append(contentsOf: sourceChildren)
+                
+                let type = source.type ?? options.defaultSourceDirectoryType ?? .group
+                if type.projectTracksChildren {
+                    let sourceChildren = (try? sourcePath.recursiveChildren()) ?? []
+                    files.append(contentsOf: sourceChildren)
+                }
                 files.append(sourcePath)
             }
         }
         return files
     }
 }
 
+extension SourceType {
+    
+    var projectTracksChildren: Bool {
+        switch self {
+        case .file: false
+        case .folder: false
+        case .group: true
+        case .syncedFolder: false
+        }
+    }
+}
+
 extension BuildSettingsContainer {
 
     fileprivate var configFilePaths: [Path] {

Sources/ProjectSpec/Project.swift

@@ -28,14 +28,35 @@ public struct Settings: Equatable, JSONObjectConvertible, CustomStringConvertibl
             groups = jsonDictionary.json(atKeyPath: "groups") ?? jsonDictionary.json(atKeyPath: "presets") ?? []
             let buildSettingsDictionary: JSONDictionary = jsonDictionary.json(atKeyPath: "base") ?? [:]
             buildSettings = buildSettingsDictionary
-            configSettings = jsonDictionary.json(atKeyPath: "configs") ?? [:]
+
+            self.configSettings = try Self.extractValidConfigs(from: jsonDictionary)
         } else {
             buildSettings = jsonDictionary
             configSettings = [:]
             groups = []
         }
     }
 
+    /// Extracts and validates the `configs` mapping from the given JSON dictionary.
+    /// - Parameter jsonDictionary: The JSON dictionary to extract `configs` from.
+    /// - Returns: A dictionary mapping configuration names to `Settings` objects.
+    private static func extractValidConfigs(from jsonDictionary: JSONDictionary) throws -> [String: Settings] {
+        guard let configSettings = jsonDictionary["configs"] as? JSONDictionary else {
+            return [:]
+        }
+
+        let invalidConfigKeys = Set(
+            configSettings.filter { !($0.value is JSONDictionary) }
+                .map(\.key)
+        )
+
+        guard invalidConfigKeys.isEmpty else {
+            throw SpecParsingError.invalidConfigsMappingFormat(keys: invalidConfigKeys)
+        }
+
+        return try jsonDictionary.json(atKeyPath: "configs")
+    }
+
     public static func == (lhs: Settings, rhs: Settings) -> Bool {
         NSDictionary(dictionary: lhs.buildSettings).isEqual(to: rhs.buildSettings) &&
             lhs.configSettings == rhs.configSettings &&

Sources/ProjectSpec/Settings.swift

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