A Swift command line tool for generating your Xcode project
Go to file
Yonas Kolb f7b8c183ca
Merge pull request #341 from rohitpal440/master
Set higher version .xcdatamodeld file as current
2018-07-18 21:21:56 +10:00
.circleci explicitly call make build in tests 2018-06-08 15:21:50 +10:00
Assets remove old logos 2017-07-31 12:35:39 +02:00
Docs document transitivelyLinkDependencies default 2018-07-06 00:10:49 +10:00
scripts add gen_fixtures script 2018-06-26 23:09:27 +10:00
SettingPresets Remove testability flag from framework template 2018-04-23 11:32:05 +03:00
Sources Use orderedAscending for comparison in sort method 2018-07-18 16:32:55 +05:30
Tests default transitivelyLinkDependencies to false 2018-07-06 00:08:33 +10:00
.gitignore revert .DS_Store gitignore now that test files are committed 2018-03-27 14:51:45 +11:00
CHANGELOG.md Update to 1.10.3 2018-07-11 20:21:28 +10:00
LICENSE copy LICENSE file 2018-02-26 19:30:16 +09:00
Makefile move brew formula to homebrew core 2018-07-15 21:37:49 +10:00
Package.resolved fix decoding dictionaries with dot keys 2018-06-26 21:29:44 +10:00
Package.resources add Package.resources for mint 2017-09-26 21:51:01 +02:00
Package.swift fix decoding dictionaries with dot keys 2018-06-26 21:29:44 +10:00
README.md move brew formula to homebrew core 2018-07-15 21:37:49 +10:00
RELEASE.md move brew formula to homebrew core 2018-07-15 21:37:49 +10:00

XcodeGen

Swift Package Manager

XcodeGen

XcodeGen is a command line tool that generates your Xcode project using your folder structure and a simple 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 as well.

  • Create projects on demand and remove your .xcodeproj file from git, which means no merge conflicts!
  • Groups in Xcode are always synced to your directories on disk
  • Easy configuration of projects which is human readable and git friendly
  • Easily copy and paste files and directories without having to edit anything in Xcode
  • Share build settings across multiple targets with build setting groups
  • Automatically generate Schemes for different environments like test and production
  • Easily create new projects with complicated setups on demand without messing around with Xcode
  • Generate from anywhere including on CI
  • Distribute your spec amongst multiple files for easy sharing and overriding
  • Easily create multi-platform frameworks
  • Integrate Carthage frameworks without any work

Given a very simple project spec file like this:

name: MyProject
options:
  bundleIdPrefix: com.myapp
targets:
  MyApp:
    type: application
    platform: iOS
    deploymentTarget: "10.0"
    sources: [MyApp]
    settings:
      CUSTOM_BUILD_SETTING: my_value
    dependencies:
      - target: MyFramework
  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.

Installing

Make sure Xcode 9.3 is installed first.

Mint

mint install yonaskolb/xcodegen

Make

git clone https://github.com/yonaskolb/XcodeGen.git
cd XcodeGen
make

Homebrew

brew install xcodegen

Swift Package Manager

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: "1.0.0"),

And then import wherever needed: import XcodeGenKit

Usage

Simply run:

xcodegen

This will look for a project spec in the current directory called project.yml

Use xcodegen --help to see the list of options:

  • --spec: An optional path to a .yml or .json project spec.
  • --project: An optional path to a directory where the project will be generated. By default this is the directory the spec lives in.
  • --quiet: Suppress informational and success messages. By default this is disabled.

Editing

git clone https://github.com/yonaskolb/XcodeGen.git
cd XcodeGen
swift package generate-xcodeproj

This use Swift Project 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.

Documentation

  • See Project Spec documentation for all the various properties and options that can be set
  • See Usage for more specific usage and use case documentation
  • See FAQ for a list of some frequently asked questions
  • See Examples for some real world XcodeGen project specs out in the wild

Attributions

This tool is powered by:

Inspiration for this tool came from:

Contributions

Pull requests and issues are welcome

License

XcodeGen is licensed under the MIT license. See LICENSE for more info.