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 file 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
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
  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

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.5.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: 2269
Help us keep the lights on

Used By

Total:

Releases

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

2.4.0 - Mar 31, 2019

Fixed:

  • Fixed installation when building in Swift 5 #549 @yonaskolb

Changed

  • Updated to Swift 5 and dropped Swift 4.2 #549 @yonaskolb

Commits

2.3.0 - Mar 25, 2019

Added

  • Added ability to automatically find all the frameworks for Carthage dependencies via the global options.findCarthageFrameworks or dependency specfic dependency.findFrameworks. See the Carthage usage docs for more info #506 #543 @rpassis @yonaskolb
  • Added support for nested target templates #534 @tomquist
  • Added ability to define templateAttributes within a target to be able to parameterize templates. #533 @tomquist
  • Added ability to set link to false in framework dependencies #532 @dimatosaurus
  • Added missingConfigFiles to options.disabledValidations to optionally skip checking for the existence of config files.
  • Added ability to define a per-platform deploymentTarget for Multi-Platform targets. #510 @ainopara

Changed

  • DEPRECATION: Placeholders $target_name and $platform have been deprecated in favour of ${target_name} and ${platform}. Support for the old placeholders will be removed in a future version #533 @tomquist

Fixed

  • Sources outside a project spec's directory will be correctly referenced as relative paths in the project file. #524 @elliottwilliams
  • Fixed error when optional path is missing #527 @yonaskolb
  • Fixed excludes within included spec #535 @yonaskolb
  • Fixed paths in target templates within included files not being relative #537 @yonaskolb
  • Fix multi-platform target templates #541 @yonaskolb
  • Fixed sources in an included target not being relative when the sources are mix of string and dictionaries #542 @yonaskolb

Commits

2.2.0 - Jan 28, 2019

Added

  • Added ability to generate empty directories via options.generateEmptyDirectories #480 @Beniamiiin
  • Added support for the instrumentsPackage product type #482 @ksulliva
  • Added support for inputFileLists and outputFileLists within project build scripts #500 @lukewakeford
  • Added support for a $target_name replacement string within target templates #504 @yonaskolb
  • Added createIntermediateGroups to individual Target Sources which overrides the top level option #505 @yonaskolb

Changed

  • BREAKING: All the paths within include files are now relative to that file and not the root spec. This can be disabled with a relativePaths: false on the include. See the documentation for more details #489 @ellneal
  • Updated the Xcode compatibility version from 3.2 to 9.3 #497 @yonaskolb
  • Exact matches to config names in build settings won't partial apply to other configs #503 @yonaskolb
  • UUIDs in the project are standard and don't contain any type prefixes anymore

Fixed

  • Fixed --project argument not taking effect #487 @monowerker
  • Fixed Sticker Packs from generating an empty Source file phase which caused in error in the new build system #492 @rpassis
  • Fixed generated schemes for tool targets not setting the executable #496 @yonaskolb
  • Fixed resolving Carthage dependencies for iOS app with watchOS target. 465 @raptorxcz

Commits

2.1.0 - Dec 18, 2018

Added

  • Added an experiment new caching feature. Pass --use-cache to opt in. This will read and write from a cache file to prevent unnecessarily generating the project. Give it a try as it may become the default in a future release #412 @yonaskolb

Changed

  • Changed spelling of build phases to preBuildPhase and postBuildPhase. The older names are deprecated but still work #402 @brentleyjones
  • Moved generation to a specific subcommand xcodegen generate. Simple xcodegen will continue to work for now #437 @yonaskolb
  • If INFOPLIST_FILE has been set on a target, then an info path won't ovewrite it #443 @feischl97

Fixed

  • Fixed XPC Service package type in generated Info.plist #435 @alvarhansen
  • Fixed phase ordering for modulemap and static libary header Copy File phases. 402 @brentleyjones
  • Fixed intermittent errors when running multiple xcodegens concurrently #450 @bryansum
  • Fixed --project argument not working #437 @yonaskolb
  • Fixed unit tests not hooking up to host applications properly by default. They now generate a TEST_HOST and a TestTargetID #452 @yonaskolb
  • Fixed static libraries not including external frameworks in their search paths #454 @brentleyjones
  • Add .intentdefinition files to sources build phase instead of resources #442 @yonaskolb
  • Add mlmodel files to sources build phase instead of resources #457 @dwb357

Commits