mirror of
https://github.com/yonaskolb/XcodeGen.git
synced 2024-09-11 12:56:03 +03:00
Compare commits
8 Commits
8418dedb4c
...
e26cbf2389
Author | SHA1 | Date | |
---|---|---|---|
|
e26cbf2389 | ||
|
f51719ce29 | ||
|
1b0720d139 | ||
|
576739bcb5 | ||
|
aa79a3ed0b | ||
|
d99e448647 | ||
|
274ce7342c | ||
|
17acb4dc61 |
14
CHANGELOG.md
14
CHANGELOG.md
@ -2,6 +2,20 @@
|
||||
|
||||
## Next Version
|
||||
|
||||
## 2.41.0
|
||||
|
||||
### Added
|
||||
|
||||
- Added `xcodegen cache` command that writes the cache. Useful for `post-commit` git hook integration #1476 @yonaskolb
|
||||
|
||||
### Changed
|
||||
|
||||
- Include folders in file sorting #1466 @jflan-dd
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed `supportedDestinations` validation when it contains watchOS for multiplatform apps. #1470 @tatsuky
|
||||
|
||||
## 2.40.1
|
||||
|
||||
### Fixed
|
||||
|
@ -2,7 +2,6 @@
|
||||
|
||||
These are a bunch of real world examples of XcodeGen project specs. Feel free to add your own via PR.
|
||||
|
||||
- [num42/RxUserDefaults](https://github.com/num42/RxUserDefaults/blob/master/Examples/CocoaPodsExample.yml)
|
||||
- [toshi0383/Bitrise-iOS](https://github.com/toshi0383/Bitrise-iOS/blob/master/project.yml)
|
||||
- [johndpope/swift-models](https://github.com/johndpope/swift-models/tree/stable/Inference)
|
||||
- [atelier-socle/AppRepositoryTemplate](https://github.com/atelier-socle/AppRepositoryTemplate/blob/master/project.yml)
|
||||
|
10
Docs/FAQ.md
10
Docs/FAQ.md
@ -9,10 +9,14 @@ Absolutely. You will get the most out of XcodeGen by adding your project to your
|
||||
>Note that you can run `xcodegen` as a step in your build process on CI.
|
||||
|
||||
## What happens when I switch branches
|
||||
If files were added or removed in the new checkout you will most likely need to run `xcodegen` again so that your project will reference all your files. Unfortunately this is a manual step at the moment, but in the future this could be automated.
|
||||
If files were added or removed in the new checkout you will most likely need to run `xcodegen` again so that your project will reference all your files.
|
||||
|
||||
For now you can always add xcodegen as a git `post-checkout` hook.
|
||||
It's recommended to use `--use-cache` so that the project is not needlessly generated.
|
||||
It's recommended to set up some [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) to automate the process:
|
||||
- run `xcodegen generate --use-cache` on the following hooks. This will make sure the project is up to date when checking out, merging and rebasing
|
||||
- `post-checkout`
|
||||
- `post-rewrite`
|
||||
- `post-merge`
|
||||
- run `xcodegen cache` on `pre-commit`. This will make sure that when switching branches the cache will be updated in case you made local changes, or are ammending a commit that added a new file.
|
||||
|
||||
## Can I use CocoaPods
|
||||
Yes, you will just need to run `pod install` after the project is generated to integrate Cocoapods changes.
|
||||
|
@ -500,7 +500,7 @@ targets:
|
||||
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).
|
||||
Note that the definition of supported destinations can be applied to almost every type of bundle making everything more easy to manage (app targets, unit tests, UI tests etc). App targets currently do not support the watchOS destination. Create a separate target using `platform` for watchOS apps. See Apple's [Configuring a multiplatform app](https://developer.apple.com/documentation/xcode/configuring-a-multiplatform-app-target) for details.
|
||||
|
||||
### Sources
|
||||
|
||||
|
2
Makefile
2
Makefile
@ -1,6 +1,6 @@
|
||||
TOOL_NAME = XcodeGen
|
||||
export EXECUTABLE_NAME = xcodegen
|
||||
VERSION = 2.40.1
|
||||
VERSION = 2.41.0
|
||||
|
||||
PREFIX = /usr/local
|
||||
INSTALL_PATH = $(PREFIX)/bin/$(EXECUTABLE_NAME)
|
||||
|
@ -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.40.1"),
|
||||
.package(url: "https://github.com/yonaskolb/XcodeGen.git", from: "2.41.0"),
|
||||
```
|
||||
|
||||
And then import wherever needed: `import XcodeGenKit`
|
||||
@ -136,7 +136,7 @@ Options:
|
||||
- **--use-cache**: Used to prevent unnecessarily generating the project. If this is set, then a cache file will be written to when a project is generated. If `xcodegen` is later run but the spec and all the files it contains are the same, the project won't be generated.
|
||||
- **--cache-path**: A custom path to use for your cache file. This defaults to `~/.xcodegen/cache/{PROJECT_SPEC_PATH_HASH}`
|
||||
|
||||
There are other commands as well such as `xcodegen dump` which lets out output the resolved spec in many different formats, or write it to a file. Use `xcodegen help` to see more detailed usage information.
|
||||
There are other commands as well such as `xcodegen dump` which lets one output the resolved spec in many different formats, or write it to a file. Use `xcodegen help` to see more detailed usage information.
|
||||
|
||||
## Dependency Diagrams
|
||||
<details>
|
||||
|
@ -185,6 +185,12 @@ extension Project {
|
||||
errors.append(.unexpectedTargetPlatformForSupportedDestinations(target: target.name, platform: target.platform))
|
||||
}
|
||||
|
||||
if let supportedDestinations = target.supportedDestinations,
|
||||
target.type.isApp,
|
||||
supportedDestinations.contains(.watchOS) {
|
||||
errors.append(.containsWatchOSDestinationForMultiplatformApp(target: target.name))
|
||||
}
|
||||
|
||||
if target.supportedDestinations?.contains(.macOS) == true,
|
||||
target.supportedDestinations?.contains(.macCatalyst) == true {
|
||||
|
||||
|
@ -19,6 +19,7 @@ public struct SpecValidationError: Error, CustomStringConvertible {
|
||||
case invalidTargetSchemeTest(target: String, testTarget: String)
|
||||
case invalidTargetPlatformForSupportedDestinations(target: String)
|
||||
case unexpectedTargetPlatformForSupportedDestinations(target: String, platform: Platform)
|
||||
case containsWatchOSDestinationForMultiplatformApp(target: String)
|
||||
case multipleMacPlatformsInSupportedDestinations(target: String)
|
||||
case missingTargetPlatformInSupportedDestinations(target: String, platform: Platform)
|
||||
case invalidSchemeTarget(scheme: String, target: String, action: String)
|
||||
@ -66,6 +67,8 @@ public struct SpecValidationError: Error, CustomStringConvertible {
|
||||
return "Target \(target.quoted) has multiple definitions of mac platforms in supported destinations"
|
||||
case let .missingTargetPlatformInSupportedDestinations(target, platform):
|
||||
return "Target \(target.quoted) has platform \(platform.rawValue.quoted) that is missing in supported destinations"
|
||||
case let .containsWatchOSDestinationForMultiplatformApp(target):
|
||||
return "Multiplatform app \(target.quoted) cannot contain watchOS in \"supportedDestinations\". Create a separate target using \"platform\" for watchOS apps"
|
||||
case let .invalidConfigFile(configFile, config):
|
||||
return "Invalid config file \(configFile.quoted) for config \(config.quoted)"
|
||||
case let .invalidSchemeTarget(scheme, target, action):
|
||||
|
@ -3,6 +3,6 @@ import ProjectSpec
|
||||
import XcodeGenCLI
|
||||
import Version
|
||||
|
||||
let version = Version("2.40.1")
|
||||
let version = Version("2.41.0")
|
||||
let cli = XcodeGenCLI(version: version)
|
||||
cli.execute()
|
||||
|
44
Sources/XcodeGenCLI/Commands/CacheCommand.swift
Normal file
44
Sources/XcodeGenCLI/Commands/CacheCommand.swift
Normal file
@ -0,0 +1,44 @@
|
||||
import Foundation
|
||||
import PathKit
|
||||
import ProjectSpec
|
||||
import SwiftCLI
|
||||
import XcodeGenKit
|
||||
import XcodeProj
|
||||
import Version
|
||||
|
||||
class CacheCommand: ProjectCommand {
|
||||
|
||||
@Key("--cache-path", description: "Where the cache file will be loaded from and save to. Defaults to ~/.xcodegen/cache/{SPEC_PATH_HASH}")
|
||||
var cacheFilePath: Path?
|
||||
|
||||
init(version: Version) {
|
||||
super.init(version: version,
|
||||
name: "cache",
|
||||
shortDescription: "Write the project cache")
|
||||
}
|
||||
|
||||
override func execute(specLoader: SpecLoader, projectSpecPath: Path, project: Project) throws {
|
||||
|
||||
let cacheFilePath = self.cacheFilePath ?? Path("~/.xcodegen/cache/\(projectSpecPath.absolute().string.md5)").absolute()
|
||||
|
||||
var cacheFile: CacheFile?
|
||||
|
||||
// generate cache
|
||||
do {
|
||||
cacheFile = try specLoader.generateCacheFile()
|
||||
} catch {
|
||||
throw GenerationError.projectSpecParsingError(error)
|
||||
}
|
||||
|
||||
// write cache
|
||||
if let cacheFile = cacheFile {
|
||||
do {
|
||||
try cacheFilePath.parent().mkpath()
|
||||
try cacheFilePath.write(cacheFile.string)
|
||||
success("Wrote cache to \(cacheFilePath)")
|
||||
} catch {
|
||||
info("Failed to write cache: \(error.localizedDescription)")
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
@ -49,7 +49,7 @@ class DumpCommand: ProjectCommand {
|
||||
try file.parent().mkpath()
|
||||
try file.write(output)
|
||||
} else {
|
||||
stdout.print(output)
|
||||
success(output)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -8,9 +8,6 @@ import Version
|
||||
|
||||
class GenerateCommand: ProjectCommand {
|
||||
|
||||
@Flag("-q", "--quiet", description: "Suppress all informational and success output")
|
||||
var quiet: Bool
|
||||
|
||||
@Flag("-c", "--use-cache", description: "Use a cache for the xcodegen spec. This will prevent unnecessarily generating the project if nothing has changed")
|
||||
var useCache: Bool
|
||||
|
||||
@ -46,7 +43,7 @@ class GenerateCommand: ProjectCommand {
|
||||
Path("~/.xcodegen/cache/\(projectSpecPath.absolute().string.md5)").absolute()
|
||||
var cacheFile: CacheFile?
|
||||
|
||||
// read cache
|
||||
// generate cache
|
||||
if useCache || self.cacheFilePath != nil {
|
||||
do {
|
||||
cacheFile = try specLoader.generateCacheFile()
|
||||
@ -138,22 +135,4 @@ class GenerateCommand: ProjectCommand {
|
||||
try Task.run(bash: command, directory: projectDirectory.absolute().string)
|
||||
}
|
||||
}
|
||||
|
||||
func info(_ string: String) {
|
||||
if !quiet {
|
||||
stdout.print(string)
|
||||
}
|
||||
}
|
||||
|
||||
func warning(_ string: String) {
|
||||
if !quiet {
|
||||
stdout.print(string.yellow)
|
||||
}
|
||||
}
|
||||
|
||||
func success(_ string: String) {
|
||||
if !quiet {
|
||||
stdout.print(string.green)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -12,6 +12,9 @@ class ProjectCommand: Command {
|
||||
let name: String
|
||||
let shortDescription: String
|
||||
|
||||
@Flag("-q", "--quiet", description: "Suppress all informational and success output")
|
||||
var quiet: Bool
|
||||
|
||||
@Key("-s", "--spec", description: "The path to the project spec file. Defaults to project.yml. (It is also possible to link to multiple spec files by comma separating them. Note that all other flags will be the same.)")
|
||||
var spec: String?
|
||||
|
||||
@ -58,4 +61,22 @@ class ProjectCommand: Command {
|
||||
}
|
||||
|
||||
func execute(specLoader: SpecLoader, projectSpecPath: Path, project: Project) throws {}
|
||||
|
||||
func info(_ string: String) {
|
||||
if !quiet {
|
||||
stdout.print(string)
|
||||
}
|
||||
}
|
||||
|
||||
func warning(_ string: String) {
|
||||
if !quiet {
|
||||
stdout.print(string.yellow)
|
||||
}
|
||||
}
|
||||
|
||||
func success(_ string: String) {
|
||||
if !quiet {
|
||||
stdout.print(string.green)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -15,6 +15,7 @@ public class XcodeGenCLI {
|
||||
description: "Generates Xcode projects",
|
||||
commands: [
|
||||
generateCommand,
|
||||
CacheCommand(version: version),
|
||||
DumpCommand(version: version),
|
||||
]
|
||||
)
|
||||
|
@ -631,8 +631,8 @@ public class PBXProjGenerator {
|
||||
}
|
||||
|
||||
if let order = groupOrdering?.order {
|
||||
let files = group.children.filter { $0 is PBXFileReference }
|
||||
var groups = group.children.filter { $0 is PBXGroup }
|
||||
let files = group.children.filter { !$0.isGroupOrFolder }
|
||||
var groups = group.children.filter { $0.isGroupOrFolder }
|
||||
|
||||
var filteredGroups = [PBXFileElement]()
|
||||
|
||||
@ -1626,6 +1626,10 @@ extension Platform {
|
||||
}
|
||||
|
||||
extension PBXFileElement {
|
||||
/// - returns: `true` if the element is a group or a folder reference. Likely an SPM package.
|
||||
var isGroupOrFolder: Bool {
|
||||
self is PBXGroup || (self as? PBXFileReference)?.lastKnownFileType == "folder"
|
||||
}
|
||||
|
||||
public func getSortOrder(groupSortPosition: SpecOptions.GroupSortPosition) -> Int {
|
||||
if type(of: self).isa == "PBXGroup" {
|
||||
|
@ -203,6 +203,32 @@ class ProjectSpecTests: XCTestCase {
|
||||
try expectValidationError(project, .unexpectedTargetPlatformForSupportedDestinations(target: "target1", platform: .watchOS))
|
||||
}
|
||||
|
||||
$0.it("watchOS in multiplatform app's supported destinations") {
|
||||
var project = baseProject
|
||||
project.targets = [
|
||||
Target(
|
||||
name: "target1",
|
||||
type: .application,
|
||||
platform: .auto,
|
||||
supportedDestinations: [.watchOS]
|
||||
)
|
||||
]
|
||||
try expectValidationError(project, .containsWatchOSDestinationForMultiplatformApp(target: "target1"))
|
||||
}
|
||||
|
||||
$0.it("watchOS in non-app's supported destinations") {
|
||||
var project = baseProject
|
||||
project.targets = [
|
||||
Target(
|
||||
name: "target1",
|
||||
type: .framework,
|
||||
platform: .auto,
|
||||
supportedDestinations: [.watchOS]
|
||||
)
|
||||
]
|
||||
try expectNoValidationError(project, .containsWatchOSDestinationForMultiplatformApp(target: "target1"))
|
||||
}
|
||||
|
||||
$0.it("multiple definitions of mac platform in supported destinations") {
|
||||
var project = baseProject
|
||||
project.targets = [
|
||||
|
@ -259,6 +259,96 @@ class PBXProjGeneratorTests: XCTestCase {
|
||||
.map { $0.nameOrPath }
|
||||
try expect(screenGroups) == ["mainScreen1.swift", "mainScreen2.swift", "View", "Presenter", "Interactor", "Entities", "Assembly"]
|
||||
}
|
||||
|
||||
$0.it("sorts SPM packages") {
|
||||
var options = SpecOptions()
|
||||
options.groupSortPosition = .top
|
||||
options.groupOrdering = [
|
||||
GroupOrdering(
|
||||
order: [
|
||||
"Sources",
|
||||
"Resources",
|
||||
"Tests",
|
||||
"Packages",
|
||||
"Support files",
|
||||
"Configurations",
|
||||
]
|
||||
),
|
||||
GroupOrdering(
|
||||
pattern: "Packages",
|
||||
order: [
|
||||
"FeatureA",
|
||||
"FeatureB",
|
||||
"Common",
|
||||
]
|
||||
),
|
||||
]
|
||||
|
||||
let directories = """
|
||||
Configurations:
|
||||
- file.swift
|
||||
Resources:
|
||||
- file.swift
|
||||
Sources:
|
||||
- MainScreen:
|
||||
- mainScreen1.swift
|
||||
- mainScreen2.swift
|
||||
- Assembly:
|
||||
- file.swift
|
||||
- Entities:
|
||||
- file.swift
|
||||
- Interactor:
|
||||
- file.swift
|
||||
- Presenter:
|
||||
- file.swift
|
||||
- View:
|
||||
- file.swift
|
||||
Support files:
|
||||
- file.swift
|
||||
Packages:
|
||||
- Common:
|
||||
- Package.swift
|
||||
- FeatureA:
|
||||
- Package.swift
|
||||
- FeatureB:
|
||||
- Package.swift
|
||||
Tests:
|
||||
- file.swift
|
||||
UITests:
|
||||
- file.swift
|
||||
"""
|
||||
try createDirectories(directories)
|
||||
|
||||
let target = Target(name: "Test", type: .application, platform: .iOS, sources: ["Configurations", "Resources", "Sources", "Support files", "Tests", "UITests"])
|
||||
let project = Project(
|
||||
basePath: directoryPath,
|
||||
name: "Test",
|
||||
targets: [target],
|
||||
packages: [
|
||||
"Common": .local(path: "Packages/Common", group: nil),
|
||||
"FeatureA": .local(path: "Packages/FeatureA", group: nil),
|
||||
"FeatureB": .local(path: "Packages/FeatureB", group: nil),
|
||||
],
|
||||
options: options
|
||||
)
|
||||
let projGenerator = PBXProjGenerator(project: project)
|
||||
|
||||
let pbxProj = try project.generatePbxProj()
|
||||
let group = try pbxProj.getMainGroup()
|
||||
|
||||
projGenerator.setupGroupOrdering(group: group)
|
||||
|
||||
let mainGroups = group.children.map { $0.nameOrPath }
|
||||
try expect(mainGroups) == ["Sources", "Resources", "Tests", "Packages", "Support files", "Configurations", "UITests", "Products"]
|
||||
|
||||
let packages = group.children
|
||||
.first { $0.nameOrPath == "Packages" }
|
||||
.flatMap { $0 as? PBXGroup }?
|
||||
.children
|
||||
.map(\.nameOrPath)
|
||||
|
||||
try expect(packages) == ["FeatureA", "FeatureB", "Common"]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -485,8 +485,8 @@ class ProjectGeneratorTests: XCTestCase {
|
||||
try expect(targetConfig1.buildSettings["CODE_SIGN_IDENTITY"] as? String) == "iPhone Developer"
|
||||
}
|
||||
|
||||
$0.it("supportedDestinations merges settings - iOS, watchOS") {
|
||||
let target = Target(name: "Target", type: .application, platform: .auto, supportedDestinations: [.iOS, .watchOS])
|
||||
$0.it("supportedDestinations merges settings - iOS, watchOS (framework)") {
|
||||
let target = Target(name: "Target", type: .framework, platform: .auto, supportedDestinations: [.iOS, .watchOS])
|
||||
let project = Project(name: "", targets: [target])
|
||||
|
||||
let pbxProject = try project.generatePbxProj()
|
||||
@ -499,8 +499,8 @@ class ProjectGeneratorTests: XCTestCase {
|
||||
try expect(targetConfig1.buildSettings["SUPPORTS_XR_DESIGNED_FOR_IPHONE_IPAD"] as? Bool) == true
|
||||
}
|
||||
|
||||
$0.it("supportedDestinations merges settings - visionOS, watchOS") {
|
||||
let target = Target(name: "Target", type: .application, platform: .auto, supportedDestinations: [.visionOS, .watchOS])
|
||||
$0.it("supportedDestinations merges settings - visionOS, watchOS (framework)") {
|
||||
let target = Target(name: "Target", type: .framework, platform: .auto, supportedDestinations: [.visionOS, .watchOS])
|
||||
let project = Project(name: "", targets: [target])
|
||||
|
||||
let pbxProject = try project.generatePbxProj()
|
||||
|
Loading…
Reference in New Issue
Block a user