Swiftpack.co - Package - yonaskolb/XcodeGen

XcodeGen

Swift Package Manager

XcodeGen

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.

  • ✅ Generate projects on demand and remove your .xcodeproj from git, which means no more merge conflicts!
  • ✅ Groups and files 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
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.

Installing

Make sure Xcode 10.2 is installed first.

Mint

mint install yonaskolb/xcodegen

Make

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

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

And then import wherever needed: import XcodeGenKit

Usage

Simply run:

xcodegen generate

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.

Options:

  • --spec: An optional path to a .yml or .json project spec. Defaults to project.yml
  • --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.
  • --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}

Use xcodegen help to see more detailed usage information.

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 always welcome. Please open any issues and PRs for bugs, features, or documentation.

License

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

Github

link
Stars: 2763
Help us keep the lights on

Releases

2.9.0 - Oct 14, 2019

Added

  • Added Scheme Templates #672 @bclymer

Fixed

  • Fixed macOS unit test setting preset #665 @yonaskolb
  • Add rcproject files to sources build phase instead of resources #669 @Qusic
  • Prefer default configuration names for generated schemes #673 @giginet
  • Fixed some resource files being placed to "Recovered References" group #679 @nivanchikov

Internal

  • Updated to SwiftCLI 5.3.2 #667 @giginet
  • Fixed tests in case-sensitive file system #670 @Qusic

Commits

2.8.0 - Sep 28, 2019

Added

  • Added support for Swift Package dependencies #624 @yonaskolb
  • Added includes to sources for a Target. This follows the same glob-style as excludes but functions as a way to only include files that match a specified pattern. Useful if you only want a certain file type, for example specifying **/*.swift. #637 @bclymer
  • Support dylib SDK. #650 @kateinoigakukun
  • Added language and region options for run and test scheme #654 @kateinoigakukun
  • Added debugEnabled option for run and test scheme #657 @kateinoigakukun

Fixed

  • Expand template variable in Array of Any #651 @kateinoigakukun
  • Significantly improve performance when running with a large number files. #658 @kateinoigakukun
  • Removed some more diffs between the generated .pbxproj and when Xcode resaves it #663 @yonaskolb

Internal

  • Removed needless Array initialization. #661 @RomanPodymov
  • Updated to XcodeProj 7.1.0 #624 @yonaskolb

Commits

2.7.0 - Sep 1, 2019

Added

  • Added Bash 4 style recursive globbing (**/*) in target sources excludes #636 @bclymer
  • Added ability to disable main thread checker in Schemes #601 @wag-miles

Fixed

  • Fixed included specs that were referenced multiple times from duplicating content #599 @haritowa
  • Fixed .orig files being added to the project #627 @keith

Changed

  • Allow linking of dependencies into static libraries when link is set to true #635 @kateinoigakukun

Commits

2.6.0 - Jun 28, 2019

Added

  • Added ability to skip tests #582 @kadarandras
  • Added ability to set attributes on build files #583 @min
  • Allow using environment variables in the form of ${SOME_VARIABLE}. This might be a breaking change when a target template attribute is also defined as an environment variable #594 @tomquist
  • Added support for watchapp2-container and framework.static product types #604 @yonaskolb

Fixed

  • Fixed .pch files being bundled as resources #597 @thii
  • Fixed an issue that prevents watchOS Intents Extension from running correctly. #571 @KhaosT

Changed

  • Updated the default compatibilityVersion project setting from Xcode 9.3 to Xcode 10.0 #581 @acecilia
  • Updated to XcodeProj 7.0.0. Note that the length of generated UUIDs has changed #604 @yonaskolb

Internal

  • Added ability to encode ProjectSpec #545 @ryohey

Commits

2.5.0 - Apr 9, 2019

Added

  • Added support for app-extension.intents-service target type #536 @yonaskolb
  • Added support for custom root in sdk dependency #562 @raptorxcz

Changed

  • Updated to xcodeproj 6.7.0 including its performance improvements #536 @yonaskolb
  • Updated default generated settings for Xcode 10.2 #555 @yonaskolb
  • Changed order of file generation so that plists are now generated before the project, so they will be included in the projects files #544 @tomquist
  • Updated Yams to 2.0.0 @yonaskolb

Fixed

  • Fixed groups from sources outside a project spec's directory from being flattened. #550 @sroebert
  • Fixed optional file sources not being added to the project #557 @yonaskolb
  • Fixed Carthage dependencies being incorrectly embedded in WatchKit app bundles instead of a WatchKit app extension #558 @KhaosT

Commits