Update spec generation with latest releases

.github/workflows/ci.yml

@@ -4,11 +4,11 @@ on:
   pull_request: {}
 jobs:
   run:
-    runs-on: macOS-latest
+    runs-on: macos-11
     name: Xcode ${{ matrix.xcode }}
     strategy:
       matrix:
-        xcode: ["12"]
+        xcode: ["12.5.1", "13.0"]
     steps:
     - uses: actions/checkout@master
     - name: Set Xcode

.gitignore

@@ -7,3 +7,4 @@ xcuserdata
 *.xcuserstate
 XcodeGen.xcodeproj
 xcodegen.zip
+.vscode/launch.json

Docs/Examples.md

@@ -10,3 +10,5 @@ These are a bunch of real world examples of XcodeGen project specs. Feel free to
 - [scelis/XcodeGen-TestStickers](https://github.com/scelis/XcodeGen-TestStickers/blob/master/project.yml)
 - [minvws/nl-covid19-notification-app-ios](https://github.com/minvws/nl-covid19-notification-app-ios/blob/master/project.yml)
 - [pvinis/react-native-xcodegen](https://github.com/pvinis/react-native-xcodegen/blob/master/templates)
+- [covid19cz/erouska-ios](https://github.com/covid19cz/erouska-ios/blob/develop/project.yml)
+- [markst/hotreloading-vscode-ios](https://github.com/markst/hotreloading-vscode-ios)

Docs/ProjectSpec.md

@@ -64,12 +64,13 @@ An include can be provided via a string (the path) or an object of the form:
 
 - [x] **path**: **String** - The path to the included file.
 - [ ] **relativePaths**: **Bool** - Dictates whether the included spec specifies paths relative to itself (the default) or the root spec file.
-
+- [ ] **enable**: **Bool** - Dictates whether the specified spec should be included or not. You can also specify it by environment variable.
 ```yaml
 include:
   - includedFile.yml
   - path: path/to/includedFile.yml
     relativePaths: false
+    enable: ${INCLUDE_ADDITIONAL_YAML}
 ```
 
 By default specs are merged additively. That is for every value:
@@ -114,6 +115,7 @@ Note that target names can also be changed by adding a `name` property to a targ
 - [ ] **disabledValidations**: **[String]** - A list of validations that can be disabled if they're too strict for your use case. By default this is set to an empty array. Currently these are the available options:
   - `missingConfigs`: Disable errors for configurations in yaml files that don't exist in the project itself. This can be useful if you include the same yaml file in different projects
   - `missingConfigFiles`: Disable checking for the existence of configuration files. This can be useful for generating a project in a context where config files are not available.
+  - `missingTestPlans`: Disable checking if test plan paths exist. This can be useful if your test plans haven't been created yet.
 - [ ] **defaultConfig**: **String** - The default configuration for command line builds from Xcode. If the configuration provided here doesn't match one in your [configs](#configs) key, XcodeGen will fail. If you don't set this, the first configuration alphabetically will be chosen.
 - [ ] **groupSortPosition**: **String** - Where groups are sorted in relation to other files. Either:
   - `none` - sorted alphabetically with all the other files
@@ -273,6 +275,7 @@ This will provide default build settings for a certain product type. It can be a
 - `application.messages`
 - `application.watchapp`
 - `application.watchapp2`
+- `application.watchapp2-container`
 - `app-extension`
 - `app-extension.intents-service`
 - `app-extension.messages`
@@ -281,14 +284,14 @@ This will provide default build settings for a certain product type. It can be a
 - `bundle.ocunit-test`
 - `bundle.ui-testing`
 - `bundle.unit-test`
+- `extensionkit-extension`
 - `framework`
 - `instruments-package`
 - `library.dynamic`
 - `library.static`
 - `framework.static`
 - `tool`
 - `tv-app-extension`
-- `watchapp2-container`
 - `watchkit-extension`
 - `watchkit2-extension`
 - `xcode-extension`
@@ -432,6 +435,19 @@ A dependency can be one of a 6 types:
 - [ ] **weak**: **Bool** - Whether the `Weak` setting is applied when linking the framework. Defaults to false
 - [ ] **platformFilter**: **String** - This field is specific to Mac Catalyst. It corresponds to the "Platforms" dropdown in the Frameworks & Libraries section of Target settings in Xcode. Available options are: **iOS**, **macOS** and **all**. Defaults is **all**
 - [ ] **platforms**: **[[Platform](#platform)]** - List of platforms this dependency should apply to. Defaults to all applicable platforms.
+- **copy** - Copy Files Phase for this dependency. This only applies when `embed` is true. Must be specified as an object with the following fields:
+    - [x] **destination**: **String** - Destination of the Copy Files phase. This can be one of the following values:
+        - `absolutePath`
+        - `productsDirectory`
+        - `wrapper`
+        - `executables`
+        - `resources`
+        - `javaResources`
+        - `frameworks`
+        - `sharedFrameworks`
+        - `sharedSupport`
+        - `plugins`
+    - [ ] **subpath**: **String** - The path inside of the destination to copy the files.
 
 **Implicit Framework options**:
 
@@ -640,13 +656,15 @@ This is a convenience used to automatically generate schemes for a target based
 - [x] **configVariants**: **[String]** - This generates a scheme for each entry, using configs that contain the name with debug and release variants. This is useful for having different environment schemes.
 - [ ] **testTargets**: **[[Test Target](#test-target)]** - a list of test targets that should be included in the scheme. These will be added to the build targets and the test entries. Each entry can either be a simple string, or a [Test Target](#test-target)
 - [ ] **gatherCoverageData**: **Bool** - a boolean that indicates if this scheme should gather coverage data. This defaults to false
+- [ ] **coverageTargets**: **[[Testable Target Reference](#testable-target-reference) - a list of targets to gather code coverage. Each entry can either be a simple string, a string using [Project Reference](#project-reference) or [Testable Target Reference](#testable-target-reference)
 - [ ] **disableMainThreadChecker**: **Bool** - a boolean that indicates if this scheme should disable the Main Thread Checker. This defaults to false
 - [ ] **stopOnEveryMainThreadCheckerIssue**: **Bool** - a boolean that indicates if this scheme should stop at every Main Thread Checker issue. This defaults to false
 - [ ] **buildImplicitDependencies**: **Bool** - Flag to determine if Xcode should build implicit dependencies of this scheme. By default this is `true` if not set.
 - [ ] **language**: **String** - a String that indicates the language used for running and testing. This defaults to nil
 - [ ] **region**: **String** - a String that indicates the region used for running and testing. This defaults to nil
 - [ ] **commandLineArguments**: **[String:Bool]** - a dictionary from the argument name (`String`) to if it is enabled (`Bool`). These arguments will be added to the Test, Profile and Run scheme actions
 - [ ] **environmentVariables**: **[[Environment Variable](#environment-variable)]** or **[String:String]** - environment variables for Run, Test and Profile scheme actions. When passing a dictionary, every key-value entry maps to a corresponding variable that is enabled.
+- [ ] **testPlans**:  **[[Test Plan](#test-plan)]** - List of test plan locations that will be referenced in the scheme.
 - [ ] **preActions**: **[[Execution Action](#execution-action)]** - Scripts that are run *before* the build action
 - [ ] **postActions**: **[[Execution Action](#execution-action)]** - Scripts that are run *after* the build action
 - [ ] **storeKitConfiguration**: **String** - specify storekit configuration to use during run. See [Options](#options).
@@ -678,6 +696,9 @@ targets:
         - Staging
         - Production
       gatherCoverageData: true
+      coverageTargets:
+        - MyTarget1
+        - ExternalTarget/OtherTarget1
       commandLineArguments:
         "-MyEnabledArg": true
         "-MyDisabledArg": false
@@ -709,7 +730,7 @@ This is used to override settings or run build scripts in specific targets
 
 ## Target Template
 
-This is a template that can be referenced from a normal target using the `templates` property. The properties of this template are the same as a [Target](#target)].
+This is a template that can be referenced from a normal target using the `templates` property. The properties of this template are the same as a [Target](#target).
 Any instances of `${target_name}` within each template will be replaced by the final target name which references the template.
 Any attributes defined within a targets `templateAttributes` will be used to replace any attribute references in the template using the syntax `${attribute_name}`.
 
@@ -811,20 +832,36 @@ A multiline script can be written using the various YAML multiline methods, for
 ### Test Action
 
 - [ ] **gatherCoverageData**: **Bool** - a boolean that indicates if this scheme should gather coverage data. This defaults to false
-- [ ] **coverageTargets**: **[String]** - a list of targets to gather code coverage. Each entry can either be a simple string, or a string using [Project Reference](#project-reference)
+- [ ] **coverageTargets**: **[[Testable Target Reference](#testable-target-reference)]** - a list of targets to gather code coverage. Each entry can either be a simple string, a string using [Project Reference](#project-reference) or [Testable Target Reference](#testable-target-reference)
 - [ ] **targets**: **[[Test Target](#test-target)]** - a list of targets to test. Each entry can either be a simple string, or a [Test Target](#test-target)
 - [ ] **customLLDBInit**: **String** - the absolute path to the custom `.lldbinit` file
 - [ ] **captureScreenshotsAutomatically**: **Bool** - indicates whether screenshots should be captured automatically while UI Testing. This defaults to true.
 - [ ] **deleteScreenshotsWhenEachTestSucceeds**: **Bool** - whether successful UI tests should cause automatically-captured screenshots to be deleted. If `captureScreenshotsAutomatically` is false, this value is ignored. This defaults to true.
+- [ ] **testPlans**:  **[[Test Plan](#test-plan)]** - List of test plan locations that will be referenced in the scheme.
 
 #### Test Target
-- [x] **name**: **String** - The name of the target
+A target can be one of a 2 types:
+
+- **name**: **String** - The name of the target.
+- **target**: **[Testable Target Reference](#testable-target-reference)** - The information of the target. You can specify more detailed information than `name:`.
+
+As syntax suger, you can also specify **[Testable Target Reference](#testable-target-reference)** without `target`.
+
+#### Other Parameters
+
 - [ ] **parallelizable**: **Bool** - Whether to run tests in parallel. Defaults to false
 - [ ] **randomExecutionOrder**: **Bool** - Whether to run tests in a random order. Defaults to false
+- [ ] **location**: **String** - GPX file or predefined value for simulating location. See [Simulate Location](#simulate-location) for location examples.
 - [ ] **skipped**: **Bool** - Whether to skip all of the test target tests. Defaults to false
 - [ ] **skippedTests**: **[String]** - List of tests in the test target to skip. Defaults to empty
 - [ ] **selectedTests**: **[String]** - List of tests in the test target to whitelist and select. Defaults to empty. This will override `skippedTests` if provided
 
+#### Testable Target Reference
+A Testable Target Reference can be one of 3 types:
+- `package: {local-swift-package-name}/{target-name}`: Name of local swift package and its target.
+- `local: {target-name}`:  Name of local target.
+- `project: {project-reference-name}/{target-name}`:  Name of local swift package and its target.
+
 ### Archive Action
 
 - [ ] **customArchiveName**: **String** - the custom name to give to the archive
@@ -884,12 +921,16 @@ schemes:
       coverageTargets:
         - MyTarget1
         - ExternalTarget/OtherTarget1
+        - package: LocalPackage/TestTarget
       targets: 
         - Tester1 
         - name: Tester2
           parallelizable: true
           randomExecutionOrder: true
           skippedTests: [Test/testExample()]
+        - package: APIClient/APIClientTests
+          parallelizable: true
+          randomExecutionOrder: true
       environmentVariables:
         - variable: TEST_ENV_VAR
           value: VALUE
@@ -904,6 +945,21 @@ schemes:
       revealArchiveInOrganizer: false
 ```
 
+### Test Plan
+For now test plans are not generated by XcodeGen and must be created in Xcode and checked in, and then referenced by path. If the test targets are added, removed or renamed, the test plans may need to be updated in Xcode.
+
+- [x] **path**: **String** - path that provides the `xctestplan` location.
+- [ ] **defaultPlan**: **Bool** - a bool that defines if given plan is the default one. Defaults to false. If no default is set on any test plan, the first plan is set as the default.
+
+```yaml
+schemes:
+  TestTarget:
+    test:
+      testPlans:
+        - path: app.xctestplan
+          defaultPlan: true
+```
+
 ## Scheme Template
 
 This is a template that can be referenced from a normal scheme using the `templates` property. The properties of this template are the same as a [Scheme](#scheme). This functions identically in practice to [Target Template](#target-template).
@@ -957,17 +1013,21 @@ Swift packages are defined at a project level, and then linked to individual tar
 ### Local Package
 
 - [x] **path**: **String** - the path to the package in local. The path must be directory with a `Package.swift`.
+- [ ] **group** : **String**- Optional path that specifies the location where the package will live in your xcode project.
 
 ```yml
 packages:
   Yams:
     url: https://github.com/jpsim/Yams
     from: 2.0.0
-  Yams:
+  Ink:
     github: JohnSundell/Ink
     from: 0.5.0
   RxClient:
     path: ../RxClient
+  AppFeature:
+    path: ../Packages
+    group: Domains/AppFeature
 ```
 
 ## Project Reference

Docs/Usage.md

@@ -36,7 +36,7 @@ The values from [xcconfig files](#xcconfig-files) will then sit a level above th
 XcodeGen applies default settings to your project and targets similar to how Xcode creates them when you create a new project or target.
 Debug and Release settings will be applied to your project. Targets will also get specific settings depending on the platform and product type.
 
->You can change or disable how these setting presets are applied via the `options.settingPresets` which you can find more about in [Options](#options)
+>You can change or disable how these setting presets are applied via the `options.settingPresets` which you can find more about in [Options](ProjectSpec.md#options)
 
 ### Settings
 The `project` and each `target` have a `settings` object that you can define. This can be a simple map of build settings or can provide build settings per `config` via `configs` or `base`. See [Settings](ProjectSpec.md#settings) for more details.

Makefile

@@ -1,6 +1,6 @@
 TOOL_NAME = XcodeGen
 export EXECUTABLE_NAME = xcodegen
-VERSION = 2.24.0
+VERSION = 2.32.0
 
 PREFIX = /usr/local
 INSTALL_PATH = $(PREFIX)/bin/$(EXECUTABLE_NAME)
@@ -46,4 +46,4 @@ brew:
 	brew bump-formula-pr --url=$(RELEASE_TAR) XcodeGen
 
 archive: build
-	./scripts/archive.sh $(EXECUTABLE_PATH)
+	./scripts/archive.sh "$(EXECUTABLE_PATH)"

Package.resolved

@@ -78,8 +78,8 @@
         "repositoryURL": "https://github.com/tuist/XcodeProj.git",
         "state": {
           "branch": null,
-          "revision": "446f3a0db73e141c7f57e26fcdb043096b1db52c",
-          "version": "8.3.1"
+          "revision": "b6de1bfe021b861c94e7c83821b595083f74b997",
+          "version": "8.8.0"
         }
       },
       {

Package.swift

@@ -11,13 +11,13 @@ let package = Package(
         .library(name: "ProjectSpec", targets: ["ProjectSpec"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/kylef/PathKit.git", from: "1.0.0"),
+        .package(url: "https://github.com/kylef/PathKit.git", from: "1.0.1"),
         .package(url: "https://github.com/jpsim/Yams.git", from: "4.0.0"),
         .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: "3.0.0"),
-        .package(url: "https://github.com/tuist/XcodeProj.git", from: "8.0.0"),
-        .package(url: "https://github.com/jakeheis/SwiftCLI.git", from: "6.0.0"),
+        .package(url: "https://github.com/tuist/XcodeProj.git", from: "8.8.0"),
+        .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/SwiftDocOrg/GraphViz.git", .exact("0.2.0")),
     ],

README.md

@@ -113,7 +113,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.24.0"),
+.package(url: "https://github.com/yonaskolb/XcodeGen.git", from: "2.32.0"),
 ```
 
 And then import wherever needed: `import XcodeGenKit`
@@ -156,7 +156,7 @@ To a file:
 xcodegen dump --type graphviz --file Graph.viz
 ```
 
-During implementation, `graphviz` formatting was validated using [GraphvizOnline](https://dreampuf.github.io/GraphvizOnline/), [WebGraphviz](http://www.webgraphviz.com), and [Graphviz on MacOS](graphviz.org).
+During implementation, `graphviz` formatting was validated using [GraphvizOnline](https://dreampuf.github.io/GraphvizOnline/), [WebGraphviz](http://www.webgraphviz.com), and [Graphviz on MacOS](https://graphviz.org).
 </details>
 
 ## Editing

Sources/ProjectSpec/Dependency.swift

@@ -17,6 +17,7 @@ public struct Dependency: Equatable {
     public var weakLink: Bool = weakLinkDefault
     public var platformFilter: PlatformFilter = platformFilterDefault
     public var platforms: Set<Platform>?
+    public var copyPhase: BuildPhaseSpec.CopyFilesSettings?
 
     public init(
         type: DependencyType,
@@ -27,7 +28,8 @@ public struct Dependency: Equatable {
         implicit: Bool = implicitDefault,
         weakLink: Bool = weakLinkDefault,
         platformFilter: PlatformFilter = platformFilterDefault,
-        platforms: Set<Platform>? = nil
+        platforms: Set<Platform>? = nil,
+        copyPhase: BuildPhaseSpec.CopyFilesSettings? = nil
     ) {
         self.type = type
         self.reference = reference
@@ -38,6 +40,7 @@ public struct Dependency: Equatable {
         self.weakLink = weakLink
         self.platformFilter = platformFilter
         self.platforms = platforms
+        self.copyPhase = copyPhase
     }
 
     public enum PlatformFilter: String, Equatable {
@@ -53,7 +56,7 @@ public struct Dependency: Equatable {
         public static let `default` = dynamic
     }
 
-    public enum DependencyType: Equatable {
+    public enum DependencyType: Hashable {
         case target
         case framework
         case carthage(findFrameworks: Bool?, linkType: CarthageLinkType)
@@ -135,6 +138,10 @@ extension Dependency: JSONObjectConvertible {
         if let platforms: [ProjectSpec.Platform] = jsonDictionary.json(atKeyPath: "platforms") {
             self.platforms = Set(platforms)
         }
+
+        if let object: JSONDictionary = jsonDictionary.json(atKeyPath: "copy") {
+            copyPhase = try BuildPhaseSpec.CopyFilesSettings(jsonDictionary: object)
+        }
     }
 }
 
@@ -144,7 +151,8 @@ extension Dependency: JSONEncodable {
             "embed": embed,
             "codeSign": codeSign,
             "link": link,
-            "platforms": platforms?.map(\.rawValue).sorted()
+            "platforms": platforms?.map(\.rawValue).sorted(),
+            "copy": copyPhase?.toJSONValue(),
         ]
 
         if removeHeaders != Dependency.removeHeadersDefault {