How to install R.swift with Swift Package Manager in Xcode?

Add the package dependency from GitHub, select the target for RswiftLibrary, and add the RswiftGenerateInternalResources build tool plugin in Build Phases. A demo video is provided in the README for visual guidance, ensuring seamless integration.

R.swift vs SwiftGen which is better for iOS projects?

R.swift integrates as a build tool plugin for a simple, all-in-one R struct, while SwiftGen offers more customization with templates. Choose R.swift for out-of-the-box Xcode autocompletion; SwiftGen if you need fine-grained control over generated code.

How to ignore resources in R.swift?

Use the Ignoring.md documentation to specify files or directories to exclude from generation. This allows you to skip resources you don't want included in the R struct, preventing unnecessary code bloat.

Can I use R.swift in a Swift Package Manager package?

Yes, add the dependency and RswiftGeneratePublicResources plugin to your Package.swift target. This enables R.swift to generate public resource accessors for use in Swift packages, as detailed in the SPM installation section.

How to fix R.swift not generating code on CI?

On CI servers like Xcode Cloud, run a script before building to disable plugin validation with 'defaults write com.apple.dt.Xcode IDESkipPackagePluginFingerprintValidatation -bool YES'. This is necessary because CI environments can't interactively approve plugins.

Open-Awesome

R.swift

MITSwift7.8.0

A Swift library providing strongly typed, autocompleted access to resources like images, fonts, and segues in iOS/macOS projects.

GitHub

9.6k stars776 forks0 contributors

What is R.swift?

R.swift is a Swift library and build tool that generates a strongly typed `R` struct to access app resources like images, fonts, colors, and localized strings. It solves the problem of using error-prone string literals for resource access by providing compile-time checked, autocompleted code that prevents runtime crashes from typos.

Target Audience

iOS and macOS developers working in Swift who want to eliminate stringly-typed resource access and improve code safety and developer experience in Xcode.

Value Proposition

Developers choose R.swift because it turns runtime errors into compile-time errors, provides full IDE autocompletion for resources, and integrates seamlessly into the Xcode build process, making resource access intuitive and robust.

Overview

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

Use Cases

Best For

Eliminating typos in image, font, or color names that cause runtime crashes
Improving autocompletion and discoverability of resources in Xcode
Enforcing type safety when accessing storyboards, segues, and nibs
Validating that all resources referenced in storyboards exist at launch
Managing localized strings with type-safe formatting parameters
Reducing boilerplate and manual string constants for resource access

Not Ideal For

Projects exclusively using Objective-C, as R.swift is Swift-only and cannot generate type-safe resource access for Objective-C code.
Apps requiring dynamic resource loading based on runtime user input or conditions that can't be determined at compile time.
Teams that prioritize a minimal build toolchain and are comfortable managing string literals manually for simplicity.

Pros & Cons

Pros

Compile-Time Safety

Catches typos in resource names at compile time instead of runtime, preventing crashes from incorrect strings, as shown in the demo where renaming an image triggers a compile error.

Full IDE Autocompletion

Provides autocompletion for images, fonts, strings, and other resources in Xcode, reducing guesswork and speeding up development, demonstrated in the autocompleted images GIF.

Broad Resource Coverage

Supports a wide range of resources including images, fonts, colors, localized strings, storyboards, and nibs, as listed in the features section with dedicated examples.

Runtime Validation

Optional R.validate() function checks for missing images, fonts, or storyboard resources at launch, ensuring all referenced assets are available, as explained in the runtime validation documentation.

Cons

Installation Complexity

Setup requires adding build tool plugins or run script phases, and on CI servers like Xcode Cloud, extra steps to disable plugin validation add overhead, as noted in the installation instructions.

Generated File Management

The R.generated.swift file must be manually added to the project and excluded from git to avoid conflicts, introducing version control complexity, as mentioned in the tip to add *.generated.swift to .gitignore.

Swift-Only Restriction

Limited to Swift projects; mixed Objective-C/Swift codebases or pure Objective-C projects cannot benefit from R.swift's type safety, which is a inherent limitation of the tool.

Frequently Asked Questions

Related Projects

infer

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

Stars15,706

Forks2,100

Last commit4 days ago

SwifterSwift

A handy collection of more than 500 native Swift extensions to boost your productivity.

Stars15,194

Forks1,660

Last commit1 month ago

SwiftGen

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

Stars9,546

Forks766

Last commit4 months ago

XcodeGen

A Swift command line tool for generating your Xcode project

Stars8,761

Forks904