Merge branch 'master' into synced_folder

Author: yonaskolb

.github/workflows/ci.yml

@@ -4,14 +4,11 @@ on:
   pull_request: {}
 jobs:
   run:
-    runs-on: ${{ matrix.macos }}
+    runs-on: macos-15
     name: Xcode ${{ matrix.xcode }}
     strategy:
       matrix:
-        xcode: ["16.0"]
-        include:
-        - xcode: "16.0"
-          macos: macos-15
+        xcode: ["16.0", "16.3"]
     env:
       DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
     steps:

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Next Version
 
+### 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
+
 ### Added
 
 - Added `excludeFromProject` from local packages #1512 @maximkrouk

Makefile

@@ -1,6 +1,6 @@
 TOOL_NAME = XcodeGen
 export EXECUTABLE_NAME = xcodegen
-VERSION = 2.42.0
+VERSION = 2.43.0
 
 PREFIX = /usr/local
 INSTALL_PATH = $(PREFIX)/bin/$(EXECUTABLE_NAME)

README.md

@@ -112,7 +112,7 @@ swift run xcodegen
 Add the following to your Package.swift file's dependencies:
 
 ```swift
-.package(url: "https://github.com/yonaskolb/XcodeGen.git", from: "2.42.0"),
+.package(url: "https://github.com/yonaskolb/XcodeGen.git", from: "2.43.0"),
 ```
 
 And then import wherever needed: `import XcodeGenKit`

Sources/ProjectSpec/AggregateTarget.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/BuildSettingsExtractor.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/Project.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 }

Sources/ProjectSpec/Settings.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/SpecParsingError.swift

@@ -15,6 +15,7 @@ public enum SpecParsingError: Error, CustomStringConvertible {
     case unknownBreakpointActionType(String)
     case unknownBreakpointActionConveyanceType(String)
     case unknownBreakpointActionSoundName(String)
+    case invalidConfigsMappingFormat(keys: Set<String>)
 
     public var description: String {
         switch self {
@@ -46,6 +47,8 @@ public enum SpecParsingError: Error, CustomStringConvertible {
             return "Unknown Breakpoint Action conveyance type: \(type)"
         case let .unknownBreakpointActionSoundName(name):
             return "Unknown Breakpoint Action sound name: \(name)"
+        case let .invalidConfigsMappingFormat(keys):
+            return "Invalid format: The value for \"\(keys.sorted().joined(separator: ", "))\" in `configs` must be mapping format"
         }
     }
 }

Sources/ProjectSpec/Target.swift

@@ -316,7 +316,7 @@ extension Target: NamedJSONDictionaryConvertible {
             deploymentTarget = nil
         }
 
-        settings = jsonDictionary.json(atKeyPath: "settings") ?? .empty
+        settings = try BuildSettingsParser(jsonDictionary: jsonDictionary).parse()
         configFiles = jsonDictionary.json(atKeyPath: "configFiles") ?? [:]
         if let source: String = jsonDictionary.json(atKeyPath: "sources") {
             sources = [TargetSource(path: source)]