A lint tool for UIStoryboard to find wrong classes and wrong storyboard/segue/reuse identifiers.
In iOS development, UIStoryboards are a pain to use for many reasons. Two big reasons are:
- You can only use string literals as identifiers for view controllers and segues in your Storyboards. You need those same string literals again in your source code when referencing anything in your Storyboard: So you have your IDs in two or more places and no way to know if the IDs you use in your code actually exist in your Storyboard.
- You have no way of knowing whether your Storyboard references classes in your source code that don't exist (anymore).
With StoryboardLint, you can finally make sure that your code and your Storyboards are in sync (at least to a certain degree). StoryboardLint does the following things:
- Makes sure your
UICollectionViewCellreuse identifiers are named according to either your own or StoryboardLint's default naming convention.
- Makes sure your Storyboard and Segue identifiers are named according to either your own or StoryboardLint's naming convention.
- Makes sure that all custom classes that are references from your Storyboard actually exist is your code.
- Makes sure that all string literals in your code that reference reuse identifiers, Storyboard identifiers and Segue identifiers (according to a given or default naming convention) actually exist in your Storyboard(s).
- Produces output that is parsable by Xcode so you can easily plug StoryboardLint into your build process:
Warnings right in your source code:
Warnings about bugs in your Storyboard:
In order for StoryboardLint to find the string literals in your code that contain reuse/Storyboard/Segue identifiers, you need to prefix and/or suffix them in a consistent way. If you don't provide any options, this is the default:
- Reuse Identifiers start with
- Storyboard Identifiers start with
- Segue Identifiers start with
However, if you already use a certain naming convention or if you would prefer a different one, you can tell StoryboardLint about it using these commandline arguments:
storyboardlint ~/Code/MyProject --storyboard-prefix MyGreatPrefix
storyboardlint ~/Code/MyProject --storyboard-suffix MyGreatSuffix
The same goes for
--reuse-suffix. You are even allowed to provide both a prefix and a suffix.
Naming your identifiers according to a consistent naming convention should not be too much work and it will be worth it. Ideally you already have string constants for these things in your code, so that you only have to edit two places: your string constant in code and the respective value in your Storyboard.
Just install the Ruby Gem:
sudo gem install storyboardlint
In your Xcode Project, simply add a "Run Script" build phase in order to run StoryboardLint every time you build:
- Go to your project and select your project's target in the "Targets" section.
- Go to "Build Phases"
- Select from the Menu "Editor -> Add Build Phase -> Add Run Script Build Phase"
- Paste this command into the Run Script section:
storyboardlint "$SRCROOT"(this will use the default naming convention). Alternatively, you can provide options to tell StoryboardLint about our own naming conventions, for example:
storyboardlint "$SRCROOT" --storyboard-suffix Storyboard --segue-suffix Segue --reuse-suffix ReuseID
- That's it!