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:
      debug:
        CUSTOM_BUILD_SETTING: my_debug_value
      release:
        CUSTOM_BUILD_SETTING: my_release_value
    dependencies:
      - target: MyFramework
      - carthage: Alamofire
  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.

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: 1628
Help us keep the lights on

Used By

Total:

Releases

1.11.2 - Sep 19, 2018

If XcodeGen is compiled with Swift 4.2, then UUID's in the generated project will not be deterministic. This will be fixed in an upcoming release with an update to xcodeproj 6.0

Fixed

  • Fixed release builds in Swift 4.2 404 @pepibumur
  • Fixed default settings for macOS unit-tests 387 @frankdilo
  • Fixed Copy Headers phase ordering for Xcode 10 401 @brentleyjones
  • Fixed generated schemes on aggregate targets 394 @vgorloff

Changed

  • Added en as default value for knownRegions 390 @Saik0s
  • Update PathKit, Spectre, Yams and xcodeproj dependencies

Commits

1.11.1 - Aug 22, 2018

Fixed

  • Fixed FRAMEWORK_SEARCH_PATHS for framework dependency paths with spaces 382 @brentleyjones
  • Fixed aggregate targets not being found with transitivelyLinkDependencies 383 @brentleyjones

Commits

1.11.0 - Aug 19, 2018

Added

  • Added showEnvVars to build scripts to disable printing the environment 351 @keith
  • Added requiresObjCLinking to target 354 @brentleyjones
  • Added targetTemplates 355 @yonaskolb
  • Added aggregateTargets 353 381 @yonaskolb
  • Added options.groupSortPosition 356 @yonaskolb
  • Added ability to specify copyFiles build phase for sources 345 @brentleyjones
  • Added ability to specify a minimumXcodeGenVersion 349 @brentleyjones
  • Added customArchiveName and revealArchiveInOrganizer to archive 367 @sxua

Fixed

  • Sort files using localizedStandardCompare 341 @rohitpal440
  • Use the latest xcdatamodel when sorted by version 341 @rohitpal440
  • Fixed compiler flags being set on non source files in mixed build phase target sources 347 @brentleyjones
  • Fixed options.xcodeVersion not being parsed 348 @brentleyjones
  • Fixed non-application targets using carthage copy-frameworks 361 @brentleyjones
  • Set xcdatamodel based on xccurrentversion if available 364 @rpassis
  • XPC Services are now correctly copied 368 @brentley
  • Fixed .metal files being added to resources 380 @vgorloff

Changed

  • Improved linking for static.library targets 352 @brentleyjones
  • Changed default group sorting to be after files 356 @yonaskolb
  • Moved Frameworks and Products top level groups to bottom 356 @yonaskolb
  • modulemap files are automatically copied to the products directory for static library targets 346 @brentleyjones
  • Public header files are automatically copied to the products directory for static library targets 365 @brentleyjones
  • Swift Objective-C Interface Header files are automatically copied to the products directory for static library targets 366 @brentleyjones
  • FRAMEWORK_SEARCH_PATHS are adjusted for framework dependencies 373 @brentley
  • library.static targets have SKIP_INSTALL set to YES 358 @brentley
  • Copy files phases have descriptive names 360 @brentley

Internal

  • Moved brew formula to homebrew core
  • Added CONTRIBUTING.md

Commits

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