Swiftpack.co - Package - yonaskolb/XcodeGen

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.

Github

link
Stars: 1241
Help us keep the lights on

Releases

1.10.3 - Jul 11, 2018

Fixed

  • Fixed Mint installations finding SettingPresets 338 @yonaskolb

Commits

1.10.2 - Jul 5, 2018

Changed

  • Set transitivelyLinkDependencies to false by default

Commits

1.10.1 - Jul 4, 2018

Fixed

  • Fixed transitivelyLinkDependencies typo 332 @brentleyjones
  • Fixed framework target dependencies not being code signed by default 332 @yonaskolb

Changed

  • Code sign all dependencies by default except target executables 332 @yonaskolb

Commits

1.10.0 - Jul 3, 2018

Added

  • Added build rule support 306 @yonaskolb
  • Added support for frameworks in sources 308 @keith
  • Added ability to automatically embed transient dependencies. Controlled with transitivelyLinkDependencies 327 @brentleyjones

Changed

  • Upgraded to Swift 4.1
  • Improved Carthage dependency lookup performance with many targets 298 @keith
  • By default don't CodeSignOnCopy target dependencies. This can still be controlled with Dependency.codeSign 324 @yonaskolb

Fixed

  • Fixed PBXBuildFile and PBXFileReference being incorrectly generated for Legacy targets 296 @sascha
  • Fixed required sources build phase not being generated if there are no sources 307 @yonaskolb
  • Fixed install script in binary release 303 @alvarhansen
  • Removed ENABLE_TESTABILITY from framework setting presets 299 @allu22
  • Fixed homebrew installation 297 @vhbit
  • cc files are now automatically recognized as source files 317 @maicki
  • Fixed commandLineArguments not parsing when they had dots in them 323 @yonaskolb
  • Fixed excluding directories that only have sub directories 326 @brentleyjones
  • Made PBXContainerItemProxy ID more deterministic
  • Fixed generated framework schemes from being executable 328 @brentleyjones

Commits

1.9.0 - Apr 12, 2018

Added

  • Scheme pre and post actions can now be added to target.scheme 280 @yonaskolb
  • Individual files can now be added to fileGroups 293 @yonaskolb

Changed

  • Updated to xcproj 4.3.0 for Xcode 9.3 updates
  • Update default Xcode version to 9.3 including new settings 284 @LinusU
  • Breaking for ProjectSpec library users Changed ProjectSpec to Project and ProjectSpec.Options to SpecOptions 281 @jerrymarino

Fixed

  • Fixed manual build phase of none not being applied to folders 288 @yonaskolb
  • Quoted values now correctly get parsed as strings 282 @yonaskolb
  • Fixed adding a root source folder when createIntermediateGroups is on 291 @yonaskolb
  • Fixed Homebrew installations issues on some machines 289 @vhbit
  • Fixed files that are added as root sources from having invalid parent groups outside the project directory 293 @yonaskolb

Commits