Merge branch 'yonaskolb:master' into master

Author: vikage

CHANGELOG.md

@@ -2,13 +2,22 @@
 
 ## Next Version
 
+## 2.38.0
+
 ### Added
 
+- [Multi-destination targets](https://github.com/yonaskolb/XcodeGen/blob/master/Docs/ProjectSpec.md#supported-destinations) #1336 @amatig
+  - Added `supportedDestinations` to target
+  - Added optional new `platform` value of `auto` when using `supportedDestinations`
+  - Added `destinationFilters` for sources and dependencies
+  - Added `inferDestinationFiltersByPath`, a convenience filter for sources
 - `.mlpackage` files now default to being a source type #1398 @aaron-foreflight
- 
+- Added support for `Build Tool Plug-ins` in `AggregateTarget` #1390 @BarredEwe
+
 ### Fixed
 
 - Fixed source file `includes` not working when no paths were found #1337 @shnhrrsn
+- Supports specifying multiple package products #1395 @simonbs
 
 ## 2.37.0
 
@@ -359,7 +368,7 @@ Some support for Xcode Test Plans has been added. For now test plans are not gen
 
 #### Fixed
 
-- Fixed issue when linking and embeding static frameworks: they should be linked and NOT embed. #820 @acecilia
+- Fixed issue when linking and embedding static frameworks: they should be linked and NOT embed. #820 @acecilia
 - Fixed issue when generating projects for paths with a dot in the folder for swift sources. #826 @asifmohd
 - Prefix static library target filenames with 'lib' to match Xcode. #831 @ileitch
 - Fixed duplicate addition of carthage static frameworks. #829 @funzin

Docs/ProjectSpec.md

@@ -22,6 +22,7 @@ You can also use environment variables in your configuration file, by using `${S
 - [Target](#target)
   - [Product Type](#product-type)
   - [Platform](#platform)
+  - [Supported Destinations](#supported-destinations)
   - [Sources](#sources)
     - [Target Source](#target-source)
   - [Dependency](#dependency)
@@ -69,7 +70,7 @@ You can also use environment variables in your configuration file, by using `${S
 - [ ] **targets**: **[String: [Target](#target)]** - The list of targets in the project mapped by name
 - [ ] **fileGroups**: **[String]** - A list of paths to add to the root of the project. These aren't files that will be included in your targets, but that you'd like to include in the project hierarchy anyway. For example a folder of xcconfig files that aren't already added by any target sources, or a Readme file.
 - [ ] **schemes**: **[Scheme](#scheme)** - A list of schemes by name. This allows more control over what is found in [Target Scheme](#target-scheme)
-- [ ] **schemeTemplates**: **[String: [Scheme Template](#scheme-template)]** - a list of schemes that can be used as templates for actual schems which reference them via a `template` property. They can be used to extract common scheme settings. Works great in combination with `include`.
+- [ ] **schemeTemplates**: **[String: [Scheme Template](#scheme-template)]** - a list of schemes that can be used as templates for actual schemes which reference them via a `template` property. They can be used to extract common scheme settings. Works great in combination with `include`.
 - [ ] **targetTemplates**: **[String: [Target Template](#target-template)]** - a list of targets that can be used as templates for actual targets which reference them via a `template` property. They can be used to extract common target settings. Works great in combination with `include`.
 - [ ] **packages**: **[String: [Swift Package](#swift-package)]** - a map of Swift packages by name.
 - [ ] **projectReferences**: **[String: [Project Reference](#project-reference)]** - a map of project references by name
@@ -357,6 +358,7 @@ Settings are merged in the following order: `groups`, `base`, `configs` (simple
 
 - [x] **type**: **[Product Type](#product-type)** - Product type of the target
 - [x] **platform**: **[Platform](#platform)** - Platform of the target
+- [ ] **supportedDestinations**: **[[Supported Destinations](#supported-destinations)]** - List of supported platform destinations for the target.
 - [ ] **deploymentTarget**: **String** - The deployment target (eg `9.2`). If this is not specified the value from the project set in [Options](#options)`.deploymentTarget.PLATFORM` will be used.
 - [ ] **sources**: **[Sources](#sources)** - Source directories of the target
 - [ ] **configFiles**: **[Config Files](#config-files)** - `.xcconfig` files per config
@@ -434,12 +436,15 @@ This will provide default build settings for a certain product type. It can be a
 
 This will provide default build settings for a certain platform. It can be any of the following:
 
+- `auto` (available only when we use `supportedDestinations`)
 - `iOS`
-- `macOS`
 - `tvOS`
+- `macOS`
 - `watchOS`
 - `visionOS` (`visionOS` doesn't support Carthage usage)
 
+Note that when we use supported destinations with Xcode 14+ we can avoid the definition of platform that fallbacks to the `auto` value.
+
 **Multi Platform targets**
 
 You can also specify an array of platforms. This will generate a target for each platform.
@@ -470,6 +475,33 @@ targets:
 
 The above will generate 2 targets named `MyFramework_iOS` and `MyFramework_tvOS`, with all the relevant platform build settings. They will both have a `PRODUCT_NAME` of `MyFramework`
 
+### Supported Destinations
+
+This will provide a mix of default build settings for the chosen platform destinations. It can be any of the following:
+
+- `iOS`
+- `tvOS`
+- `macOS`
+- `macCatalyst`
+- `visionOS`
+
+```yaml
+targets:
+  MyFramework:
+    type: framework
+    supportedDestinations: [iOS, tvOS]
+    deploymentTarget:
+      iOS: 9.0
+      tvOS: 10.0
+    sources:
+      - path: MySources
+        inferDestinationFiltersByPath: true
+      - path: OtherSources
+        destinationFilters: [iOS]
+```
+
+Note that the definition of supported destinations can be applied to every type of bundle making everything more easy to manage (app targets, unit tests, UI tests etc).
+
 ### Sources
 
 Specifies the source directories for a target. This can either be a single source or a list of sources. Applicable source files, resources, headers, and `.lproj` files will be parsed appropriately.
@@ -484,7 +516,9 @@ A source can be provided via a string (the path) or an object of the form:
 - [ ] **compilerFlags**: **[String]** or **String** - A list of compilerFlags to add to files under this specific path provided as a list or a space delimited string. Defaults to empty.
 - [ ] **excludes**: **[String]** - A list of [global patterns](https://en.wikipedia.org/wiki/Glob_(programming)) representing the files to exclude. These rules are relative to `path` and _not the directory where `project.yml` resides_. XcodeGen uses Bash 4's Glob behaviors where globstar (**) is enabled.
 - [ ] **includes**: **[String]** - A list of global patterns in the same format as `excludes` representing the files to include. These rules are relative to `path` and _not the directory where `project.yml` resides_. If **excludes** is present and file conflicts with **includes**, **excludes** will override the **includes** behavior.
-- [ ] **createIntermediateGroups**: **Bool** - This overrides the value in [Options](#options)
+- [ ] **destinationFilters**: **[[Supported Destinations](#supported-destinations)]** - List of supported platform destinations the files should filter to. Defaults to all supported destinations.
+- [ ] **inferDestinationFiltersByPath**: **Bool** - This is a convenience filter that helps you to filter the files if their paths match these patterns `**/<supportedDestination>/*` or `*_<supportedDestination>.swift`. Note, if you use `destinationFilters` this flag will be ignored.
+- [ ] **createIntermediateGroups**: **Bool** - This overrides the value in [Options](#options).
 - [ ] **optional**: **Bool** - Disable missing path check. Defaults to false.
 - [ ] **buildPhase**: **String** - This manually sets the build phase this file or files in this directory will be added to, otherwise XcodeGen will guess based on the file extension. Note that `Info.plist` files will never be added to any build phases, no matter what this setting is. Possible values are:
 	- `sources` - Compile Sources phase
@@ -520,9 +554,11 @@ targets:
   MyTarget:
     sources: MyTargetSource
   MyOtherTarget:
+    supportedDestinations: [iOS, tvOS]
     sources:
       - MyOtherTargetSource1
       - path: MyOtherTargetSource2
+        inferDestinationFiltersByPath: true
         name: MyNewName
         excludes:
           - "ios/*.[mh]"
@@ -534,6 +570,7 @@ targets:
           - "-Werror"
           - "-Wextra"
       - path: MyOtherTargetSource3
+        destinationFilters: [iOS]
         compilerFlags: "-Werror -Wextra"
       - path: ModuleMaps
         buildPhase:
@@ -561,10 +598,11 @@ A dependency can be one of a 6 types:
 
 - [ ] **embed**: **Bool** - Whether to embed the dependency. Defaults to true for application target and false for non application targets.
 - [ ] **link**: **Bool** - Whether to link the dependency. Defaults to `true` depending on the type of the dependency and the type of the target (e.g. static libraries will only link to executables by default).
-- [ ] **codeSign**: **Bool** - Whether the `codeSignOnCopy` setting is applied when embedding framework. Defaults to true
-- [ ] **removeHeaders**: **Bool** - Whether the `removeHeadersOnCopy` setting is applied when embedding the framework. Defaults to true
-- [ ] **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**
+- [ ] **codeSign**: **Bool** - Whether the `codeSignOnCopy` setting is applied when embedding framework. Defaults to true.
+- [ ] **removeHeaders**: **Bool** - Whether the `removeHeadersOnCopy` setting is applied when embedding the framework. Defaults to true.
+- [ ] **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**.
+- [ ] **destinationFilters**: **[[Supported Destinations](#supported-destinations)]** - List of supported platform destinations this dependency should filter to. Defaults to all supported destinations.
 - [ ] **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:
@@ -614,13 +652,17 @@ projectReferences:
     path: path/to/FooLib.xcodeproj
 targets:
   MyTarget:
+    supportedDestinations: [iOS, tvOS]
     dependencies:
       - target: MyFramework
+        destinationFilters: [iOS]
       - target: FooLib/FooTarget
       - framework: path/to/framework.framework
+        destinationFilters: [tvOS]
       - carthage: Result
         findFrameworks: false
         linkType: static
+        destinationFilters: [iOS]
       - sdk: Contacts.framework
       - sdk: libc++.tbd
       - sdk: libz.dylib
@@ -646,7 +688,8 @@ targets:
 ```
 
 **Package dependency**
-- [ ] **product**: **String** - The product to use from the package. This defaults to the package name, so is only required if a Package has multiple libraries or a library with a differing name
+- [ ] **product**: **String** - The product to use from the package. This defaults to the package name, so is only required if a Package has multiple libraries or a library with a differing name. Use this over `products` when you want to define different linking options per product.
+- [ ] **products**: **String** - A list of products to use from the package. This can be used when depending on multiple products from a package.
 
 ```yaml
 packages:
@@ -664,6 +707,21 @@ targets:
         product: SPMUtility
 ```
 
+Depending on multiple products from a package:
+
+```yaml
+packages:
+  FooFeature:
+    path: Packages/FooFeature
+targets:
+  App:
+    dependencies:
+      - package: FooFeature
+        products:
+          - FooDomain
+          - FooUI
+```
+
 ### Config Files
 
 Specifies `.xcconfig` files for each configuration.

Makefile

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

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.37.0"),
+.package(url: "https://github.com/yonaskolb/XcodeGen.git", from: "2.38.0"),
 ```
 
 And then import wherever needed: `import XcodeGenKit`

SettingPresets/Platforms/tvOS.yml

@@ -1,3 +1,3 @@
-TARGETED_DEVICE_FAMILY: 3
 LD_RUNPATH_SEARCH_PATHS: ["$(inherited)", "@executable_path/Frameworks"]
 SDKROOT: appletvos
+TARGETED_DEVICE_FAMILY: 3

SettingPresets/SupportedDestinations/iOS.yml

@@ -0,0 +1,5 @@
+SUPPORTED_PLATFORMS: iphoneos iphonesimulator
+TARGETED_DEVICE_FAMILY: '1,2'
+SUPPORTS_MACCATALYST: NO
+SUPPORTS_MAC_DESIGNED_FOR_IPHONE_IPAD: YES
+SUPPORTS_XR_DESIGNED_FOR_IPHONE_IPAD: YES

SettingPresets/SupportedDestinations/macCatalyst.yml

@@ -0,0 +1,2 @@
+SUPPORTS_MACCATALYST: YES
+SUPPORTS_MAC_DESIGNED_FOR_IPHONE_IPAD: NO

SettingPresets/SupportedDestinations/macOS.yml

@@ -0,0 +1,3 @@
+SUPPORTED_PLATFORMS: macosx
+SUPPORTS_MACCATALYST: NO
+SUPPORTS_MAC_DESIGNED_FOR_IPHONE_IPAD: NO

SettingPresets/SupportedDestinations/tvOS.yml

@@ -0,0 +1,2 @@
+SUPPORTED_PLATFORMS: appletvos appletvsimulator
+TARGETED_DEVICE_FAMILY: '3'

SettingPresets/SupportedDestinations/visionOS.yml

@@ -0,0 +1,3 @@
+SUPPORTED_PLATFORMS: xros xrsimulator
+TARGETED_DEVICE_FAMILY: '7'
+SUPPORTS_XR_DESIGNED_FOR_IPHONE_IPAD: NO