R.swift Plugin for Xcode

This Xcode Plugin can generate a resource file like the R.java of Android automatically in Swift.

It make you access resources like colors, images or localizable strings easier and more accurately with syntax highlighting.

Usage

Strings

Get strings by calling string(R.string.{string_name})

let str: String = string(R.string.hello_world)

Or use the abbreviated form

let str: String = string(.hello_world)

If you have some localizable string files, the string(R.string.{string_name}) will show the text in your language.

• Base.lproj/Localizable.strings

// titles
"title1" = "Title 1";
"title2" = "Title 2";

// hello world
"hello_world" = "Hello, world!";

• es.lproj/Localizable.strings

// titles
"title1" = "título 1";
"title2" = "título 2";

// hello world
"hello_world" = "Hola mundo!";

Images

Assume there is any *.xcassets folder in your project

• Images.xcassets

Get images by calling image(R.string.{image_name})

imageView.image = image(R.image.icon_play)

or

imageView.image = image(.icon_play)

Colors

Create a Color.strings file first and define some colors you like. The hex code of colors should follow #RRGGBB, #RGB, #AARRGGBB or #ARGB rules.

• Color.strings

// colors
"dark_red"       = "#8B0000";
"popcorn_yellow" = "#FAA";
"lake_michigan"  = "#DE50A6C2";
"cat_eye"        = "#EBE5";

And get colors by calling color(R.color.{color_name})

view.backgroundColor = color(R.color.popcorn_yellow)

or

view.backgroundColor = color(.popcorn_yellow)

...

Java-like Syntax

R.swift supports the Java-like syntax if you used to code Java. But still suggest using a Swift syntax.

getString(R.string.hello_world)
getString(.hello_world)

getImage(R.image.icon_play)
getImage(.icon_play)

getColor(R.color.popcorn_yellow)
getColor(.popcorn_yellow)

How to Install

Install it via Alcatraz and search R.swift

or

1. Clone this repository and build it.
2. Restart Xcode.

or

1. Download and unzip a release to ~/Library/Application Support/Developer/Shared/Xcode/Plug-ins.
2. Restart Xcode.

After restarting Xcode, open any project and

1. The first use
   • Click Edit -> R.swift -> Enable Auto Sync
2. If you want to manually sync
   • Click Edit -> R.swift -> Sync
3. If you don't use R.swift in this project anymore
   • Click Edit -> R.swift -> Clean