Need help with R.swift?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

mac-cain13
7.7K Stars 543 Forks MIT License 1.2K Commits 61 Opened issues

Description

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

Services available

!
?

Need anything else?

Contributors list

R.swift Version License Platform

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:

swift
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:

swift
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 or hear about how Fabric.app uses R.swift!

Demo

Autocompleted images:

Autocompleted images

Compiletime checked images:

Compiletime checked images

This is only the beginning, check out more examples!

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.

R.swift presentation at CocoaHeadsNL

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 - Fonts - Resource files - Colors - Localized strings - Storyboards - Segues - Nibs - Reusable cells

Runtime validation with

R.validate()
: - 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

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:
    "$PODS_ROOT/R.swift/rswift" generate "$SRCROOT/R.generated.swift"
    
  4. Add
    $TEMP_DIR/rswift-lastrun
    to the "Input Files" and
    $SRCROOT/R.generated.swift
    to the "Output Files" of the Build Phase
  5. 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

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:
    if mint list | grep -q 'R.swift'; then
     mint run R.swift rswift generate "$SRCROOT/R.generated.swift"
    else
     echo "error: R.swift not installed; run 'mint bootstrap' to install"
     return -1
    fi
    
  4. Add
    $TEMP_DIR/rswift-lastrun
    to the "Input Files" and
    $SRCROOT/R.generated.swift
    to the "Output Files" of the Build Phase
  5. 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:
    "$SRCROOT/rswift" generate "$SRCROOT/R.generated.swift"
    
  5. Add
    $TEMP_DIR/rswift-lastrun
    to the "Input Files" and
    $SRCROOT/R.generated.swift
    to the "Output Files" of the Build Phase
  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

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 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.

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.