GenStore
GenStore is a lightweight swift code generator for your resources. GenStore can create classes for your images, colors and localized strings.
Using String-based APIs to access your resources has many drawbacks. There’s always the risk of typos, as well as using resources that are no longer there. Auto generating code from resources and using it ensures that all the drawbacks from using String-based APIs will simply cease to exist as they will be automatically caught while compiling. You will also have the benefit of auto-completion which is always cool.
Installation
Using Mint
$ mint install hassaanelgarem/GenStore-swift
From Source
$ git clone https://github.com/hassaanelgarem/GenStore-swift
$ cd GenStore-swift
$ make
Usage
$ gen-store --type <type> --source <source> --output <output>
Options:
- –type: Type of the store being generated. Accepted values: [
colors,images,strings] - –source: Path of the source used to generate the store
- –output: Path of the output file
All three options are required for the command to run.
For more details use: gen-store --help
Strings Store Example
To generate a swift class from a .strings file use the following command:
$ gen-store --type strings --source Localizable.strings --output StringsStore.swift
Given the following Localizable.strings file:
"jim" = "Bears. Beets. Battlestar Galactica.";
"dwight" = "Identity theft is not a joke, Jim!";
The generated code will look like this:
class StringsStore {
static let jim = "jim".localized
static let dwight = "dwight".localized
}
fileprivate extension String {
var localized: String {
return NSLocalizedString(self, comment: "")
}
}
And now you can use it this way in your code:
let message = StringsStore.jim
let reply = StringsStore.dwight
Colors Store Example
To generate a swift class represting your colors from an xcassets file use the following command:
$ gen-store --type colors --source Colors.xcasseets --output ColorsStore.swift
Given the following Colors.xcasseets file:
The generated code will look like this:
class ColorsStore {
static let dijonMustard: UIColor = Self.unwrappedColor(named: "dijonMustard")
static let spicyBrown: UIColor = Self.unwrappedColor(named: "spicyBrown")
static let yellowMustard: UIColor = Self.unwrappedColor(named: "yellowMustard")
static func unwrappedColor(named name: String) -> UIColor {
guard let color = UIColor(named: name) else {
print("[ERROR] - Color with name (\"\(name)\") not found in assets cataloug")
return UIColor.white
}
return color
}
}
And now you can use it this way in your code:
let shirtColor = ColorsStore.spicyBrown
Images Store Example
To generate a swift class represting your images from an xcassets file use the following command:
$ gen-store --type images --source Images.xcasseets --output ImagesStore.swift
Given the following Images.xcasseets file:
The generated code will look like this:
class ImagesStore {
static let babiesPoster: UIImage? = UIImage(named: "babiesPoster")
static let chairModel: UIImage? = UIImage(named: "chairModel")
}
And now you can use it this way in your code:
let theOne = ImagesStore.chairModel
Xcode Integration
To make the best out of GenStore, you should integrate it in your Xcode project by adding it as a “Run Script Build Phase”. By doing so, this will generate your classes every time you build your project, which will make sure that your generated classes are always up to date.
Adding a new script phase:
-
Open project file form inside Xcode by selecting it from the project navigator on the left
-
Select your app target
-
Select “Build Phases” tab
-
Click on the “+” button to add a new phase then select “New Run Script Phase”
-
Name the new phase whatever you want
-
Fill in the script the same way you would use GenStore in the terminal. You can make use of environment variables to make the script work on any machine. Your script can look something like this:
gen-store -t strings -s $SRCROOT/Example/Storyboards/en.lproj/Localizable.strings -o $SRCROOT/Example/Stores/StringsStore.swift gen-store -t images -s $SRCROOT/Example/Resources/Assets.xcassets -o $SRCROOT/Example/Stores/ImagesStore.swift gen-store -t colors -s $SRCROOT/Example/Resources/Assets.xcassets -o $SRCROOT/Example/Stores/ColorsStore.swift
Alternatives
If GenStore doesn’t meet your needs try SwiftGen which is a great alternative.
License
GenStore is licensed under the MIT license. See LICENSE for more info.
