How do I integrate Sourcery into my Xcode project?

Sourcery can be added via CocoaPods, Homebrew, or Swift Package Manager. For Xcode, set up a custom build phase to run the sourcery command with a .sourcery.yml configuration file, as detailed in the usage section.

Sourcery vs SwiftGen: which should I use for asset code generation?

Sourcery is best for general Swift boilerplate like mocks and Equatable, while SwiftGen is specialized for assets like .xib and .storyboards. The README notes they are complementary tools, so use both if needed for different tasks.

Can Sourcery generate code for SwiftUI views?

Yes, through custom Stencil templates, Sourcery can automate SwiftUI code generation, such as creating view modifiers or binding setups, but it requires writing templates tailored to your specific use cases.

How to create a custom template for Sourcery?

Start by learning Stencil syntax from the documentation, then define templates based on Swift types in your project. Examples are provided for common uses, and you can extend them for advanced automation like property diffing.

Does Sourcery work with Swift Package Manager on Linux?

Yes, Sourcery supports Linux and can be used as a Swift package command plugin, but note that JS templates are not supported when building with SPM, as mentioned in the installation section.

What are the limitations of AutoMockable in Sourcery?

AutoMockable generates basic mocks for protocols, but complex protocols with associated types, generic constraints, or advanced behaviors might require manual adjustments or custom templates to handle properly.

Is Sourcery Pro necessary for advanced features?

Sourcery Pro offers a Stencil editor and Xcode integration for live AST templates, but the core tool is open-source and free. Pro is useful for teams needing enhanced editor support, but not required for basic code generation.

Open-Awesome

Sourcery

MITSwift2.3.0

A Swift code generator that automates boilerplate code using meta-programming and SwiftSyntax.

Visit Website GitHub

8.0k stars634 forks0 contributors

What is Sourcery?

Sourcery is a code generator for Swift that uses meta-programming to automate boilerplate code. It analyzes Swift source code and generates additional code based on customizable templates, solving the problem of writing repetitive, error-prone code for tasks like mocking, Equatable conformance, and Codable implementations.

Target Audience

Swift developers working on iOS, macOS, or Linux projects who need to reduce boilerplate code, improve code consistency, and automate repetitive coding patterns.

Value Proposition

Developers choose Sourcery because it dramatically reduces manual coding effort, ensures consistency across generated code, and integrates seamlessly with Swift projects through multiple installation methods including Swift Package Manager, CocoaPods, and Homebrew.

Overview

Meta-programming for Swift, stop writing boilerplate code.

Use Cases

Best For

Automatically generating mock implementations for Swift protocols in unit tests
Adding Equatable and Hashable conformance to complex Swift types
Implementing advanced Codable support for Swift enums and structs
Generating LinuxMain.swift files for Swift package manager projects
Creating lenses for immutable data structures in functional Swift
Automating UI generation for app settings or configuration screens

Not Ideal For

Teams requiring real-time code generation without separate build steps, as Sourcery must be run manually or integrated into the build process.
Projects with minimal boilerplate code where the overhead of setting up and maintaining Sourcery templates outweighs the benefits.
Environments with strict policies against generated code or external tool dependencies, due to code review or compliance requirements.

Pros & Cons

Pros

Massive Time Savings

Automatically generates hundreds of lines of mock code per protocol, as shown in the TL;DR example, drastically reducing manual effort for common tasks like AutoMockable.

Consistency and Accuracy

Ensures generated code like Equatable conformance is uniform and updates automatically with refactors, minimizing human error in boilerplate.

Flexible Template System

Supports Stencil templates for custom code generation, allowing automation of any describable algorithm beyond built-in use cases such as UI generation.

Proven Production Reliability

Used in over 40,000 projects including major apps like Airbnb and The New York Times, indicating robust community adoption and maintenance.

Cons

Steep Learning Curve

Creating custom templates requires proficiency in Stencil templating language and understanding of SwiftSyntax, which can be challenging for newcomers without prior experience.

Build-Time Overhead

Integration as a command-line tool or build phase adds complexity to the development workflow and can slow down build times, especially in large projects.

Swift-Exclusive Limitation

Only supports Swift, making it unsuitable for projects using multiple programming languages or needing cross-platform code generation tools.

Dependency on External Updates

Relies on stable SwiftSyntax, which might break with Swift compiler updates, requiring frequent maintenance and potential downtime for generated code.

Frequently Asked Questions

Related Projects

infer

A static analyzer for Java, C, C++, and Objective-C

Strong typed, autocompleted resources like images, fonts and segues in Swift projects

Stars9,569

Forks779

Last commit1 year ago

SwiftGen

The Swift code generator for your assets, storyboards, Localizable.strings, … — Get rid of all String-based APIs!

Stars9,552

Forks765

Last commit3 months ago

XcodeGen

A Swift command line tool for generating your Xcode project

Stars8,642

Forks888

Last commit8 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub