|ReleasedLast Release||Sep 2018|
|LOCLines of Code||0|
Sourcery scans your source code, applies your personal templates and generates Swift code for you, allowing you to use meta-programming techniques to save time and decrease potential mistakes.
Using it offers many benefits:
Sourcery is so meta that it is used to code-generate its boilerplate code
Table of Contents generated with DocToc
Swift features very limited runtime and no meta-programming features. Which leads our projects to contain boilerplate code.
Sourcery exists to allow Swift developers to stop doing the same thing over and over again while still maintaining strong typing, preventing bugs and leveraging compiler.
Have you ever?
If you did then you probably found yourself writing repetitive code to deal with those scenarios, does this feel right?
Even worse, if you ever add a new property to a type all of those implementations have to be updated, or you will end up with bugs. In those scenarios usually compiler will not generate the error for you, which leads to error prone code.
Download latest release with prebuilt binary from release tab. Unzip the archive into desired destination and run
Add pod 'Sourcery' to your Podfile and run
pod update Sourcery. This will download latest release binary and will put it to your project's CocoaPods path so you will run it with
Building from source
Download latest release source code from release tab or clone the repository an build Sourcery manually.
Building with Swift Package Manager
swift build -c release in the root folder. This will create a
.build/release folder and will put binary there. Move the whole
.build/release folder to your desired destination and run with
Note: Swift and JS templates are not supported when building with SPM yet.
Building with Xcode
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
Sourcery is a command line tool, you can either run it manually or in a custom build phase using following command:
$ ./sourcery --sources <sources path> --templates <templates path> --output <output path>
Note: this command may be different depending on the way in which you installed Sourcery (see Installing)
--sources- Path to a source swift files. You can provide multiple paths using multiple
--templates- Path to templates. File or Directory. You can provide multiple paths using multiple
--output[default: current path] - Path to output. File or Directory.
--config[default: current path] - Path to config file. Directory. See Configuration file.
--args- Additional arguments to pass to templates. Each argument can have explicit value or will have implicit
truevalue. Arguments should be separated with
,without spaces (i.e.
--args arg1=value,arg2). Arguments are accessible in templates via
--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 emmit 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
You can also provide arguments using
.sourcery.yml file in project's root directory, like this:
sources: - <sources path> - <sources path> templates: - <templates path> - <templates path> output: <output path> args: <name>: <value>
You can exlude some sources or templates using
sources: include: - <sources path to include> - <sources path to include> exclude: - <sources path to exclude> - <sources path to exclude> templates: include: - <templates path to include> - <templates path to include> exclude: - <templates path to exclude> - <templates path to exclude>
You can provide either sources paths or targets to scan:
project: file: <path to xcodeproj file> root: <path to project sources root> target: name: <target name> module: <module name> //required if different from target name
You can use several
target objects to scan multiple targets from one project or to scan multiple projects.
Note: Paths in configuration file are by default relative to configuration file path. If you want to specify absolute path start it with
For more information please read DOCUMENTATION.
Contributions to Sourcery are welcomed and encouraged!
It is easy to get involved. Please see the Contributing guide for more details.
To give clarity of 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 I think it articulates my values well. For more, see the Code of Conduct.
Sourcery is available under the MIT license. See LICENSE for more information.
This tool is powered by
Thank you! for:
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:
You can follow me on twitter for news/updates about other projects I am creating.