In-Depth Sourcery guide is covered as part of my SwiftyStack engineering course.
Sourcery Pro provides a powerful Stencil editor and extends Xcode with the ability to handle live AST templates: available on Mac App Store
Overview.mp4
Sourcery is a code generator for Swift language, built on top of Apple's own SwiftSyntax. It extends the language abstractions to allow you to generate boilerplate code automatically.
It's used in over 40,000 projects on both iOS and macOS and it powers some of the most popular and critically-acclaimed apps you have used (including Airbnb, Bumble, New York Times). 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!
Sourcery allows you to get rid of repetitive code and create better architecture and developer workflows.
An example might be implementing Mocks for all your protocols, without Sourcery you will need to write hundreds lines of code per each protocol like this:
class MyProtocolMock: MyProtocol {
//MARK: - sayHelloWith
var sayHelloWithNameCallsCount = 0
var sayHelloWithNameCalled: Bool {
return sayHelloWithNameCallsCount > 0
}
var sayHelloWithNameReceivedName: String?
var sayHelloWithNameReceivedInvocations: [String] = []
var sayHelloWithNameClosure: ((String) -> Void)?
func sayHelloWith(name: String) {
sayHelloWithNameCallsCount += 1
sayHelloWithNameReceivedName = name
sayHelloWithNameReceivedInvocations.append(name)
sayHelloWithNameClosure?(name)
}
}and with Sourcery ?
extension MyProtocol: AutoMockable {}Sourcery removes the need to write any of the mocks code, how many protocols do you have in your project? Imagine how much time you'll save, using Sourcery will also make every single mock consistent and if you refactor or add properties, the mock code will be automatically updated for you, eliminating possible human errors.
Sourcery can be applied to arbitrary problems across your codebase, if you can describe an algorithm to another human, you can automate it using Sourcery.
Most common uses are:
- Equality & Hashing
- Enum cases & Counts
- Lenses
- Mocks & Stubs
- LinuxMain
- Decorators
- Persistence and advanced Codable
- Property level diffing
But how about more specific use-cases, like automatically generating all the UI for your app BetaSetting? you can use Sourcery for that too
Once you start writing your own template and learn the power of Sourcery you won't be able to live without it.
There are plenty of tutorials for different uses of Sourcery, and you can always ask for help in our Swift Forum Category.
- The Magic of Sourcery is a great starting tutorial
- Generating Swift Code for iOS deals with JSON handling code
- How To Automate Swift Boilerplate with Sourcery generates conversions to dictionaries
- Codable Enums implements Codable support for Enumerations
- Sourcery Workshops
You can also watch this quick getting started and intro to mocking video by Inside iOS Dev:
-
Binary form
Download the latest release with the prebuilt binary from release tab. Unzip the archive into the desired destination and run
bin/sourcery -
brew install sourcery -
Add
pod 'Sourcery'to yourPodfileand runpod 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/sourceryIf you only want to install the
sourcerybinary, you may want to use theCLI-Onlysubspec:pod 'Sourcery', :subspecs => ['CLI-Only']. -
mint run krzysztofzablocki/Sourcery -
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 releasein the root folder and then copy.build/release/sourceryto your desired destination.Note: JS templates are not supported when building with SPM yet.
-
Building with Xcode
Run
xcodebuild -scheme sourcery -destination generic/platform=macOS -archivePath sourcery.xcarchive archiveand export the binary from the archive.
-
-
SPM (for plugin use only) Add the package dependency to your
Package.swiftmanifest from version1.8.3.
.package(url: "https://github.com/krzysztofzablocki/Sourcery.git", from: "1.8.3")
- pre-commit
Add the dependency to
.pre-commit-config.yaml.
- repo: https://github.com/krzysztofzablocki/Sourcery
rev: 1.9.1
hooks:
- id: sourcery
Full documentation for the latest release is available here.
Linux support is described on this page.
Sourcery is a command line tool; you can either run it manually or in a custom build phase using the following command:
$ ./bin/sourcery --sources <sources path> --templates <templates path> --output <output path>
Note: this command differs depending on how you installed Sourcery (see Installation)
Sourcery can now be used as a Swift package command plugin. In order to do this, the package must be added as a dependency to your Swift package or Xcode project (see Installation above).
To provide a configuration for the plugin to use, place a .sourcery.yml file at the root of the target's directory (in the sources folder rather than the root of the package).
To verify the plugin can be found by SwiftPM, use:
$ swift package plugin --list
To run the code generator, you need to allow changes to the project with the --allow-writing-to-package-directory flag:
$ swift package --allow-writing-to-package-directory sourcery-command
Inside a project/package that uses this command plugin, right-click the project and select "SourceryCommand" from the "SourceryPlugins" menu group.
⚠️ Note that this is only available from Xcode 14 onwards.
--sources- Path to a source swift files or directories. You can provide multiple paths using multiple--sourcesoption.--templates- Path to templates. File or Directory. You can provide multiple paths using multiple--templatesoptions.--force-parse- File extensions of Sourcery generated file you want to parse. You can provide multiple extension using multiple--force-parseoptions. (i.e.file.toparse.swiftwill be parsed even if generated by Sourcery if--force-parse toparse). Useful when trying to implement a multiple phases generation.--force-parsecan also be used to process within a sourcery annotation. For example to process code withinsourcery:inline:auto:Type.AutoCodableannotation you can use--force-parse AutoCodable--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 implicittruevalue. Arguments should be separated with,without spaces (i.e.--args arg1=value,arg2). Arguments are accessible in templates viaargument.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--cacheBasePath- Base path to the cache directory. Can be overriden by the config file.--buildPath- Path to directory used when building from .swifttemplate files. This defaults to system temp directory--hideVersionHeader[default: false] - Stop adding the Sourcery version to the generated files headers.
Instead of CLI arguments, you can use a .sourcery.yml configuration file:
sources:
- <sources path>
- <sources path>
templates:
- <templates path>
- <templates path>
forceParse:
- <string value>
- <string value>
output:
<output path>
args:
<name>: <value>Read more about this configuration file here.
If you get an unverified developer warning when using binary zip distribution try:
xattr -dr com.apple.quarantine Sourcery-1.1.1
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.
If you'd like to support Sourcery development you can do so through GitHub Sponsors or Open Collective, it's highly appreciated 🙇
If you are a company and would like to sponsor the project directly and get it's logo here, you can contact me directly
Sourcery is available under the MIT license. See LICENSE for more information.
This tool is powered by
- Stencil and few other libs by Kyle Fuller
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.
- JP Simard for creating SourceKitten that originally powered Sourcery and was instrumental in making this project happen.
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.