XcodeGen is a command line tool written in Swift that generates your Xcode project using your folder structure and a project spec.
The project spec is a YAML or JSON file that defines your targets, configurations, schemes, custom build settings and many other options. All your source directories are automatically parsed and referenced appropriately while preserving your folder structure. Sensible defaults are used in many places, so you only need to customize what is needed. Very complex projects can also be defined using more advanced features.
.xcodeprojfrom git, which means no more merge conflicts!
Given an example project spec:
name: MyProject include: - base_spec.yml options: bundleIdPrefix: com.myapp packages: Yams: url: https://github.com/jpsim/Yams from: 2.0.0 targets: MyApp: type: application platform: iOS deploymentTarget: "10.0" sources: [MyApp] settings: configs: debug: CUSTOM_BUILD_SETTING: my_debug_value release: CUSTOM_BUILD_SETTING: my_release_value dependencies: - target: MyFramework - carthage: Alamofire - framework: Vendor/MyFramework.framework - sdk: Contacts.framework - sdk: libc++.tbd - package: Yams MyFramework: type: framework platform: iOS sources: [MyFramework]
A project would be created with 2 connected targets, with all the required configurations and build settings. See the Project Spec documentation for all the options you can specify, and Usage for more general documentation.
Make sure Xcode 11 is installed first.
mint install yonaskolb/xcodegen
git clone https://github.com/yonaskolb/XcodeGen.git cd XcodeGen make install
brew install xcodegen
Use as CLI
git clone https://github.com/yonaskolb/XcodeGen.git cd XcodeGen swift run xcodegen
Use as dependency
Add the following to your Package.swift file's dependencies:
.package(url: "https://github.com/yonaskolb/XcodeGen.git", from: "2.24.0"),
And then import wherever needed:
This will look for a project spec in the current directory called
project.yml and generate an Xcode project with the name defined in the spec.
.jsonproject spec. Defaults to
xcodegenis later run but the spec and all the files it contains are the same, the project won't be generated.
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.
xcodegen dump --type graphviz
To a file:
xcodegen dump --type graphviz --file Graph.viz
git clone https://github.com/yonaskolb/XcodeGen.git cd XcodeGen swift package generate-xcodeproj
This uses Swift Package Manager to create an
xcodeproj file that you can open, edit and run in Xcode, which makes editing any code easier.
If you want to pass any required arguments when running in Xcode, you can edit the scheme to include launch arguments.
If XcodeGen doesn't meet your needs try these great alternatives:
This tool is powered by:
Inspiration for this tool came from:
Pull requests and issues are always welcome. Please open any issues and PRs for bugs, features, or documentation.
XcodeGen is licensed under the MIT license. See LICENSE for more info.
|Last commit: 1 week ago|