Meta-programming for Swift, stop writing boilerplate code.
Clone or download
Latest commit cb533d7 Nov 15, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.bundle Cache base path configurable via yaml file (#612) May 7, 2018
.circleci Xcode 10 & Swift 4.2 (#683) Sep 22, 2018
Pods Update Stencil (#690) Oct 5, 2018
Resources docs: update readme Dec 25, 2016
Scripts Replaced PackageContent.sh bash script with a swift script Oct 10, 2018
Sourcery-Example Fix running sourcery script (#389) Aug 2, 2017
Sourcery.xcodeproj Replaced PackageContent.sh bash script with a swift script Oct 10, 2018
Sourcery.xcworkspace Update Stencil (#690) Oct 5, 2018
Sourcery Inject version into SwiftTemplate to use for dedicated build folder Oct 10, 2018
SourceryJS Allow using JS templates with SPM (#508) Feb 6, 2018
SourceryRuntime Added `optional` attribute for methods (used in protocols exposed to … Nov 9, 2018
SourcerySwift Inject version into SwiftTemplate to use for dedicated build folder Oct 10, 2018
SourceryTests Added `optional` attribute for methods (used in protocols exposed to … Nov 9, 2018
Sources Moved js templates to a separate framework (#503) Jan 29, 2018
Templates Update Stencil (#690) Oct 5, 2018
bin Fix the creation of a symbolic link to bin/sourcery (#671) Sep 5, 2018
docs docs update Sep 23, 2018
guides Codable enums improvement (#685) Sep 25, 2018
.codecov.yml chore: disable code generated code from codecov Dec 23, 2016
.gitignore Git-ignored IDEA based IDEs configurations. (#569) Mar 31, 2018
.gitmodules removed submodule Mar 25, 2017
.jazzy.yaml move Codable to examples section Apr 21, 2018
.ruby-version Swift 4.1 (#571) Apr 11, 2018
.sourcery.yml Fixed invalid frameworks path when compiling swift template (#311) May 21, 2017
.swift-version Xcode 10 & Swift 4.2 (#683) Sep 22, 2018
.swiftlint.yml included SourceryRuntime in linting May 28, 2017
ABOUT.md generated jazzy docs Apr 11, 2017
CHANGELOG.md Updated CHANGELOG Nov 9, 2018
CODE_OF_CONDUCT.md chore: initial commit Dec 11, 2016
CONTRIBUTING.md Stop pre-numbering things. (#449) Dec 4, 2017
Dangerfile [danger] Add changelog update requirement when changing templates (#484) Jan 15, 2018
Gemfile Xcode 10 & Swift 4.2 (#683) Sep 22, 2018
Gemfile.lock Xcode 10 & Swift 4.2 (#683) Sep 22, 2018
LICENSE Initial commit Dec 11, 2016
Package.resolved Update Stencil (#690) Oct 5, 2018
Package.swift Update Stencil (#690) Oct 5, 2018
Podfile Update Stencil (#690) Oct 5, 2018
Podfile.lock Update Stencil (#690) Oct 5, 2018
README.md Update README.md Aug 28, 2018
RELEASING.md Release to homebrew rake task; (#379) Sep 28, 2017
Rakefile Swift 4.1 (#571) Apr 11, 2018
Sourcery.podspec docs: update metadata for 0.15.0 release Sep 23, 2018

README.md

CircleCI codecov docs Version License Platform

Sourcery is a code generator for Swift language, built on top of Apple's own SourceKit. It extends the language abstractions to allow you to generate boilerplate code automatically.

It's used in over 30,000 projects on both iOS and macOS and it powers some of the most popular and critically-acclaimed apps you have used. Its massive community adoption was one of the factors that pushed Apple to implement derived Equality and automatic Codable conformance. Sourcery is maintained by a growing community of contributors.

Try Sourcery for your next project or add it to an existing one -- you'll save a lot of time and be happy you did!

TL;DR

Sourcery allows you to get rid of repetitive tasks. An example might be implementing Equatable, without Sourcery you need to implement stuff like this:

extension Person: Equatable {
    static func ==(lhs: Person, rhs: Person) -> Bool {
        guard lhs.firstName == rhs.firstName else { return false }
        guard lhs.lastName == rhs.lastName else { return false }
        guard lhs.birthDate == rhs.birthDate else { return false }
        return true
    }
}

This is trivial code but imagine doing this across ten types. Across fifty. How many structs and classes are in your project?

Sourcery removes the need to write this code. And if you refactor or add properties, the equality code will be automatically updated for you, eliminating possible human errors.

Sourcery automation can be applied to many more domains, e.g.

  • Equality & Hashing
  • Enum cases & Counts
  • Lenses
  • Mocks & Stubs
  • LinuxMain
  • Decorators
  • JSON coding
  • NSCoding and Codable

It's trivial to write new templates to remove boilerplate that is specific to your projects.

How To Get Started

There are plenty of tutorials for different uses of Sourcery, and you can always ask for help in our Swift Forum Category.

Installation

  • Binary form

    Download the latest release with the prebuilt binary from release tab. Unzip the archive into the desired destination and run bin/sourcery

  • Homebrew

    brew install sourcery

  • CocoaPods

    Add pod 'Sourcery' to your Podfile and run pod update Sourcery. This will download the latest release binary and will put it in your project's CocoaPods path so you will run it with $PODS_ROOT/Sourcery/bin/sourcery

  • Mint

    Run mint run krzysztofzablocki/Sourcery.

    Note: Constraints of SPM (see below) apply.

  • Building from source

    Download the latest release source code from the release tab or clone the repository and build Sourcery manually.

    • Building with Swift Package Manager

      Run swift build -c release in the root folder. This will create a .build/release folder and will put the binary there. Move the whole .build/release folder to your desired destination and run with path_to_release_folder/sourcery

      Note: Swift and JS templates are not supported when building with SPM yet.

    • Building with Xcode

      Open Sourcery.xcworkspace and build with Sourcery-Release scheme. This will create Sourcery.app in the Derived Data folder. You can copy it to your desired destination and run with path_to_sourcery_app/Sourcery.app/Contents/MacOS/Sourcery

Documentation

Full documentation for the latest release is available here.

Usage

Sourcery is a command line tool; you can either run it manually or in a custom build phase using the following command:

$ ./sourcery --sources <sources path> --templates <templates path> --output <output path>

Note: this command differs depending on how you installed Sourcery (see Installing)

Command line options

  • --sources - Path to a source swift files or directories. You can provide multiple paths using multiple --sources option.
  • --templates - Path to templates. File or Directory. You can provide multiple paths using multiple --templates options.
  • --force-parse - File extensions of Sourcery generated file you want to parse. You can provide multiple extension using multiple --force-parse options. (i.e. file.toparse.swift will be parsed even if generated by Sourcery if --force-parse toparse). Useful when trying to implement a multiple phases generation.
  • --output [default: current path] - Path to output. File or Directory.
  • --config [default: current path] - Path to config file. File or Directory. See Configuration file.
  • --args - Additional arguments to pass to templates. Each argument can have an explicit value or will have implicit true value. Arguments should be separated with , without spaces (i.e. --args arg1=value,arg2). Arguments are accessible in templates via argument.name
  • --watch [default: false] - Watch both code and template folders for changes and regenerate automatically.
  • --verbose [default: false] - Turn on verbose logging
  • --quiet [default: false] - Turn off any logging, only emit errors
  • --disableCache [default: false] - Turn off caching of parsed data
  • --prune [default: false] - Prune empty generated files
  • --version - Display the current version of Sourcery
  • --help - Display help information

Configuration file

Instead of CLI arguments you can use a .sourcery.yml configuration file:

sources:
  - <sources path>
  - <sources path>
templates:
  - <templates path>
  - <templates path>
force-parse:
  - <string value>
  - <string value>
output:
  <output path>
args:
  <name>: <value>

Read more about this configuration file here.

Contributing

Contributions to Sourcery are welcomed and encouraged!

It is easy to get involved. Please see the Contributing guide for more details.

A list of contributors is available through GitHub.

To clarify what is expected of our community, Sourcery has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities, and articulates my values well. For more, see the Code of Conduct.

License

Sourcery is available under the MIT license. See LICENSE for more information.

Attributions

This tool is powered by

Thank you! to:

  • Mariusz Ostrowski for creating the logo.
  • Artsy Eidolon team, because we use their codebase as a stub data for performance testing the parser.
  • Olivier Halligon for showing me his setup scripts for CLI tools which are powering our rakefile.

Other Libraries / Tools

If you want to generate code for asset related data like .xib, .storyboards etc. use SwiftGen. SwiftGen and Sourcery are complementary tools.

Make sure to check my other libraries and tools, especially:

  • KZPlayground - Powerful playgrounds for Swift and Objective-C
  • KZFileWatchers - Daemon for observing local and remote file changes, used for building other developer tools (Sourcery uses it)

You can follow me on Twitter for news/updates about other projects I am creating.