R.swift

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

Code Quality Rank: L3

Programming language: Swift

License: MIT License

Tags: Tools    

Latest version: v5.3.1

README

R.swift [](blob/master/License)

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

Why use this?

It makes your code that uses resources:

• Fully typed, less casting and guessing what a method will return
• Compile time checked, no more incorrect strings that make your app crash at runtime
• Autocompleted, never have to guess that image name again

Currently you type:

let icon = UIImage(named: "settings-icon")
let font = UIFont(name: "San Francisco", size: 42)
let color = UIColor(named: "indicator highlight")
let viewController = CustomViewController(nibName: "CustomView", bundle: nil)
let string = String(format: NSLocalizedString("welcome.withName", comment: ""), locale: NSLocale.current, "Arthur Dent")

With R.swift it becomes:

let icon = R.image.settingsIcon()
let font = R.font.sanFrancisco(size: 42)
let color = R.color.indicatorHighlight()
let viewController = CustomViewController(nib: R.nib.customView)
let string = R.string.localizable.welcomeWithName("Arthur Dent")

Check out [more examples](Documentation/Examples.md) or hear about how Fabric.app uses R.swift!

Demo

Autocompleted images:

[Autocompleted images](Documentation/Images/DemoUseImage.gif)

Compiletime checked images:

[Compiletime checked images](Documentation/Images/DemoRenameImage.gif)

This is only the beginning, check out [more examples](Documentation/Examples.md)!

CocoaHeadsNL presentation

Mathijs Kadijk presented R.swift at the September 2016 CocoaHeadsNL meetup. Talking about the ideas behind R.swift and demonstrating how to move from plain stringly-typed iOS code to statically typed code.

Features

After installing R.swift into your project you can use the R-struct to access resources. If the struct is outdated just build and R.swift will correct any missing/changed/added resources.

R.swift currently supports these types of resources:

• [Images](Documentation/Examples.md#images)
• [Fonts](Documentation/Examples.md#custom-fonts)
• [Resource files](Documentation/Examples.md#resource-files)
• [Colors](Documentation/Examples.md#colors)
• [Localized strings](Documentation/Examples.md#localized-strings)
• [Storyboards](Documentation/Examples.md#storyboards)
• [Segues](Documentation/Examples.md#segues)
• [Nibs](Documentation/Examples.md#nibs)
• [Reusable cells](Documentation/Examples.md#reusable-table-view-cells)

Runtime validation with [R.validate()](Documentation/Examples.md#runtime-validation):

• If all images used in storyboards and nibs are available
• If all named colors used in storyboards and nibs are available
• If all view controllers with storyboard identifiers can be loaded
• If all custom fonts can be loaded

Q&A

• [Why was R.swift created?](Documentation/QandA.md#why-was-rswift-created)
• [Why should I choose R.swift over alternative X or Y?](Documentation/QandA.md#why-should-i-choose-rswift-over-alternative-x-or-y)
• [What are the requirements to run R.swift?](Documentation/QandA.md#what-are-the-requirements-to-run-rswift)
• [How to use methods with a Void argument?](Documentation/QandA.md#how-to-use-methods-with-a-void-argument)
• [How to fix missing imports in the generated file?](Documentation/QandA.md#how-to-fix-missing-imports-in-the-generated-file)
• [How to use classes with the same name as their module?](Documentation/QandA.md#how-to-use-classes-with-the-same-name-as-their-module)
• [Can I ignore resources?](Documentation/Ignoring.md)
• [Can I use R.swift in a library?](Documentation/QandA.md#can-i-use-rswift-in-a-library)
• [How does R.swift work?](Documentation/QandA.md#how-does-rswift-work)
• [How to upgrade to a new major version?](Documentation/Migration.md)
• How can I only run specific generators?

Installation

CocoaPods is the recommended way of installation, as this avoids including any binary files into your project.

Note on Carthage: R.swift is a tool used in a build step, it is not a dynamic library. Therefore it is not possible to install it with Carthage.

CocoaPods (recommended)

1. Add pod 'R.swift' to your Podfile and run pod install
2. In Xcode: Click on your project in the file list, choose your target under TARGETS, click the Build Phases tab and add a New Run Script Phase by clicking the little plus icon in the top left
3. Drag the new Run Script phase above the Compile Sources phase and below Check Pods Manifest.lock, expand it and paste the following script:
   bash "$PODS_ROOT/R.swift/rswift" generate "$SRCROOT/R.generated.swift"
4. Add $SRCROOT/R.generated.swift to the "Output Files" of the Build Phase
5. Uncheck "Based on dependency analysis" so that R.swift is run on each build
6. Build your project, in Finder you will now see a R.generated.swift in the $SRCROOT-folder, drag the R.generated.swift files into your project and uncheck Copy items if needed

Screenshot of the Build Phase can be found [here](Documentation/Images/BuildPhaseExample.png)

Tip: Add the *.generated.swift pattern to your .gitignore file to prevent unnecessary conflicts.

Mint

First, Install R.Swift Binary and Run Script Phase

1. Add mac-cain13/R.swift to your Mintfile and run mint bootstrap to install this package without linking it globally (recommended)
2. In Xcode: Click on your project in the file list, choose your target under TARGETS, click the Build Phases tab and add a New Run Script Phase by clicking the little plus icon in the top left
3. Drag the new Run Script phase above the Compile Sources phase, expand it and paste the following script:
   bash if mint list | grep -q 'R.swift'; then mint run [email protected] rswift generate "$SRCROOT/R.generated.swift" else echo "error: R.swift not installed; run 'mint bootstrap' to install" return -1 fi
4. Add $SRCROOT/R.generated.swift to the "Output Files" of the Build Phase
5. Uncheck "Based on dependency analysis" so that R.swift is run on each build
6. Build your project, in Finder you will now see a R.generated.swift in the $SRCROOT-folder, drag the R.generated.swift files into your project and uncheck Copy items if needed

Tip: Add the *.generated.swift pattern to your .gitignore file to prevent unnecessary conflicts.

Second, Install R.Swift.Library via the Swift Package Manager (requires Xcode 11)

If you see a build error No such module 'Rswift' when trying to #import Rswift at the top of the R.generated.swift file, then you will also need to install the library via the Swift Package Manager available in Xcode 11+.

Head over to the R.Swift.Library repo and follow the Swift Package Manager installation instructions.

Homebrew

R.swift is also available through Homebrew. This makes it possible to install R.swift globally on your system. Install R.swift by running: brew install rswift. The Homebrew formula is maintained by @tomasharkema.

Manually

1. Add the R.swift.Library to your project
2. Download a R.swift release, unzip it and put it into your source root directory
3. In Xcode: Click on your project in the file list, choose your target under TARGETS, click the Build Phases tab and add a New Run Script Phase by clicking the little plus icon in the top left
4. Drag the new Run Script phase above the Compile Sources phase, expand it and paste the following script:
   bash "$SRCROOT/rswift" generate "$SRCROOT/R.generated.swift"
5. Add $SRCROOT/R.generated.swift to the "Output Files" of the Build Phase
6. Uncheck "Based on dependency analysis" so that R.swift is run on each build
7. Build your project, in Finder you will now see a R.generated.swift in the $SRCROOT-folder, drag the R.generated.swift files into your project and uncheck Copy items if needed

Screenshot of the Build Phase can be found [here](Documentation/Images/ManualBuildPhaseExample.png)

Tip: Add the *.generated.swift pattern to your .gitignore file to prevent unnecessary conflicts.

Building from source

R.swift is built using Swift Package Manager (SPM).

1. Check out the code
2. Run swift build -c release from the root directory
3. Follow the manual installation steps with the binary you now have

For developing on R.swift in Xcode, run swift package generate-xcodeproj --xcconfig-overrides RswiftConfig.xcconfig.

Contribute

We'll love contributions, read the [contribute docs](Documentation/Contribute.md) for info on how to report issues, submit ideas and submit pull requests!

License

R.swift and R.swift.Library are created by Mathijs Kadijk and released under a [MIT License](License).

Special thanks to Tom Lokhorst for his major contributions and help maintaining this project.