Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krzysztofzablocki/sourcery
Meta-programming for Swift, stop writing boilerplate code.
https://github.com/krzysztofzablocki/sourcery
code-generation codegen codegenerator ios metaprogramming swift templates
Last synced: 14 days ago
JSON representation
Meta-programming for Swift, stop writing boilerplate code.
- Host: GitHub
- URL: https://github.com/krzysztofzablocki/sourcery
- Owner: krzysztofzablocki
- License: mit
- Created: 2016-12-11T11:49:25.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-30T18:36:58.000Z (8 months ago)
- Last Synced: 2024-04-13T21:17:26.950Z (7 months ago)
- Topics: code-generation, codegen, codegenerator, ios, metaprogramming, swift, templates
- Language: Swift
- Homepage: http://merowing.info
- Size: 55.8 MB
- Stars: 7,507
- Watchers: 87
- Forks: 602
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: Funding.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/krzysztofzablocki/Sourcery/actions/workflows/test_macOS.yml)
[](https://github.com/krzysztofzablocki/Sourcery/actions/workflows/test_ubuntu.yml)
[](https://krzysztofzablocki.github.io/Sourcery/index.html)
[](http://cocoapods.org/pods/Sourcery)
[](http://cocoapods.org/pods/Sourcery)
[](http://cocoapods.org/pods/Sourcery)
[**In-Depth Sourcery guide is covered as part of my SwiftyStack engineering course.**](https://www.swiftystack.com/)
**Sourcery Pro provides a powerful Stencil editor and extends Xcode with the ability to handle live AST templates: [available on Mac App Store](https://apps.apple.com/us/app/sourcery-pro/id1561780836?mt=12)**
https://user-images.githubusercontent.com/1468993/114271090-f6c19200-9a0f-11eb-9bd8-d7bb15129eb2.mp4
[Learn more about Sourcery Pro](http://merowing.info/sourcery-pro/)
**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](https://github.com/krzysztofzablocki/Sourcery/graphs/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 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:
```swift
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 ?
```swift
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](https://krzysztofzablocki.github.io/Sourcery/equatable.html) & [Hashing](https://krzysztofzablocki.github.io/Sourcery/hashable.html)
- [Enum cases & Counts](https://krzysztofzablocki.github.io/Sourcery/enum-cases.html)
- [Lenses](https://krzysztofzablocki.github.io/Sourcery/lenses.html)
- [Mocks & Stubs](https://krzysztofzablocki.github.io/Sourcery/mocks.html)
- [LinuxMain](https://krzysztofzablocki.github.io/Sourcery/linuxmain.html)
- [Decorators](https://krzysztofzablocki.github.io/Sourcery/decorator.html)
- [Persistence and advanced Codable](https://krzysztofzablocki.github.io/Sourcery/codable.html)
- [Property level diffing](https://krzysztofzablocki.github.io/Sourcery/diffable.html)
But how about more specific use-cases, like automatically generating all the UI for your app `BetaSetting`? [you can use Sourcery for that too](https://github.com/krzysztofzablocki/AutomaticSettings)
Once you start writing your own template and learn the power of Sourcery you won't be able to live without it.
## 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](https://forums.swift.org/c/related-projects/sourcery).
- [The Magic of Sourcery](https://www.caseyliss.com/2017/3/31/the-magic-of-sourcery) is a great starting tutorial
- [Generating Swift Code for iOS](https://www.raywenderlich.com/158803/sourcery-tutorial-generating-swift-code-ios) deals with JSON handling code
- [How To Automate Swift Boilerplate with Sourcery](https://atomicrobot.io/blog/sourcery/) generates conversions to dictionaries
- [Codable Enums](https://littlebitesofcocoa.com/318-codable-enums) implements Codable support for Enumerations
- [Sourcery Workshops](https://github.com/krzysztofzablocki/SourceryWorkshops)
### Quick Mocking Intro & Getting Started Video
You can also watch this quick getting started and intro to mocking video by Inside iOS Dev:
[](https://youtu.be/-ZbBNuttlt4?t=214)
## Installation
- _Binary form_
Download the latest release with the prebuilt binary from [release tab](https://github.com/krzysztofzablocki/Sourcery/releases/latest). Unzip the archive into the desired destination and run `bin/sourcery`
- _[Homebrew](https://brew.sh)_
`brew install sourcery`
- _[CocoaPods](https://cocoapods.org)_
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`
If you only want to install the `sourcery` binary, you may want to use the `CLI-Only` subspec: `pod 'Sourcery', :subspecs => ['CLI-Only']`.
- _[Mint](https://github.com/yonaskolb/Mint)_
`mint run krzysztofzablocki/Sourcery`
- _Building from Source_
Download the latest release source code from [the release tab](https://github.com/krzysztofzablocki/Sourcery/releases/latest) or clone the repository and build Sourcery manually.
- _Building with Swift Package Manager_
Run `swift build -c release` in the root folder and then copy `.build/release/sourcery` to 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 archive` and export the binary from the archive.
- _SPM (for plugin use only)_
Add the package dependency to your `Package.swift` manifest from version `1.8.3`.
```
.package(url: "https://github.com/krzysztofzablocki/Sourcery.git", from: "1.8.3")
```
- _[pre-commit](https://pre-commit.com/)_
Add the dependency to `.pre-commit-config.yaml`.
```
- repo: https://github.com/krzysztofzablocki/Sourcery
rev: 1.9.1
hooks:
- id: sourcery
```
## Documentation
Full documentation for the latest release is available [here](http://merowing.info/Sourcery/).
## Linux Support
Linux support is [described on this page](LINUX.md).
## Usage
### Running the executable
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 --templates --output
```
> Note: this command differs depending on how you installed Sourcery (see [Installation](#installation))
### Swift Package command
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](#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).
#### Running from the command line
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
```
#### Running in Xcode
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.
### 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. `--force-parse` can also be used to process within a sourcery annotation. For example to process code within `sourcery:inline:auto:Type.AutoCodable` annotation 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](#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
- `--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.
### Configuration file
Instead of CLI arguments, you can use a `.sourcery.yml` configuration file:
```yaml
sources:
-
-
templates:
-
-
forceParse:
-
-
output:
args:
:
```
Read more about this configuration file [here](https://krzysztofzablocki.github.io/Sourcery/usage.html#configuration-file).
## Issues
If you get an unverified developer warning when using binary zip distribution try:
`xattr -dr com.apple.quarantine Sourcery-1.1.1`
## Contributing
Contributions to Sourcery are welcomed and encouraged!
It is easy to get involved. Please see the [Contributing guide](CONTRIBUTING.md) for more details.
[A list of contributors is available through GitHub](https://github.com/krzysztofzablocki/Sourcery/graphs/contributors).
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](CODE_OF_CONDUCT.md).
## Sponsoring
If you'd like to support Sourcery development you can do so through [GitHub Sponsors](https://github.com/sponsors/krzysztofzablocki) or [Open Collective](https://opencollective.com/sourcery), 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](mailto:[email protected]?subject=[Sourcery-Sponsorship])
### Sponsors
[
](https://team.bumble.com/teams/engineering)
[
](https://airbnb.io/)
## License
Sourcery is available under the MIT license. See [LICENSE](LICENSE) for more information.
## Attributions
This tool is powered by
- [Stencil](https://github.com/kylef/Stencil) and few other libs by [Kyle Fuller](https://github.com/kylef)
Thank you! to:
- [Mariusz Ostrowski](http://twitter.com/faktory) for creating the logo.
- [Artsy Eidolon](https://github.com/artsy/eidolon) team, because we use their codebase as a stub data for performance testing the parser.
- [Olivier Halligon](https://github.com/AliSoftware) for showing me his setup scripts for CLI tools which are powering our rakefile.
- [JP Simard](https://github.com/jpsim) for creating [SourceKitten](https://github.com/jpsim/SourceKitten) that originally powered Sourcery and was instrumental in making this project happen.
## Other Libraries / Tools
If you want to generate code for asset related data like .xib, .storyboards etc. use [SwiftGen](https://github.com/AliSoftware/SwiftGen). SwiftGen and Sourcery are complementary tools.
Make sure to check my other libraries and tools, especially:
- [KZPlayground](https://github.com/krzysztofzablocki/KZPlayground) - Powerful playgrounds for Swift and Objective-C
- [KZFileWatchers](https://github.com/krzysztofzablocki/KZFileWatchers) - Daemon for observing local and remote file changes, used for building other developer tools (Sourcery uses it)
You can [follow me on Twitter][1] for news/updates about other projects I am creating.
[1]: http://twitter.com/merowing_