The static allValues constant has been deprecated in favor of the allImages and allColors constants. This is because we've added support for named colors in asset catalogs.
If you're moving from SwiftGen 4.x to SwiftGen 5.0, you'll need to be aware that some templates have been renamed, removed or merged with others. Follow this Migration Guide to use the new name for SwiftGen 5.x of the templates you were previously using with SwiftGen 4.x.
The two general themes for this version are:
- Templates now reside in the subfolder corresponding to their subcommand (
colors,fonts, ...) instead of the filename being prefixed with it. - The
defaulttemplate doesn't exist anymore, templates now specify which swift version they support.
Below is a list of renamed ("➡️") and removed ("❌") templates, grouped by subcommand. If your template hasn't been renamed or removed, you don't need to do anything ("✅"). You still might want to review the documentation for that template, as there might be new features you may be interested in.
| Old | New | Reason |
|---|---|---|
default |
➡️ swift2 |
|
rawvalues |
❌ deleted | Seldomly used |
swift3 |
✅ swift3 |
| Old | New | Reason |
|---|---|---|
default |
➡️ swift2 |
|
swift3 |
✅ swift3 |
| Old | New | Reason |
|---|---|---|
allvalues |
➡️ swift2/swift3 |
All templates by default now generate an allValues static constant |
default |
swift2 |
Now integrates the recursive features of the previously named dot-syntax template |
dot-syntax |
➡️ swift2 |
|
dot-syntax-swift3 |
➡️ swift3 |
|
swift3 |
swift3 |
Now integrates the recursive features of the previously named dot-syntax-swift3 template |
images subcommand from SwiftGen 4.x has been renamed xcassets in SwiftGen 5.0, so be sure to put those templates in a xcassets subfolder and not an images subfolder.
| Old | New | Reason |
|---|---|---|
default |
➡️ swift2 |
|
lowercase |
❌ deleted | No longer needed since we prefix classes with their module |
osx-default |
➡️ swift2 |
Unified with the iOS template, just use swift2 |
osx-lowercase |
❌ deleted | No longer needed since we prefix classes with their module |
osx-swift3 |
➡️ swift3 |
Unified with the iOS template, just use swift3 |
swift3 |
swift3 |
You'll probably need to adapt your call sites. See below. |
uppercase |
❌ deleted | No longer needed since we prefix classes with their module |
| Old | New | Reason |
|---|---|---|
default |
➡️ flat-swift2 |
|
dot-syntax |
➡️ structured-swift2 |
|
dot-syntax-swift3 |
➡️ structured-swift3 |
|
genstrings |
❌ deleted | Seldomly used |
no-comments-swift3 |
❌ deleted | The other templates now support a noComments parameter |
structured |
❌ deleted | Deprecated by dot-syntax (now called structured-swift2/3) |
swift3 |
➡️ flat-swift3 |
You'll probably notice that your old codebase won't work with the new generated code. This is because we use a new, swiftier way of generating types for storyboard scenes. What it boils down to is that, if you had the following line in your code base:
StoryboardScene.Message.instantiateMessageList()It should now become:
StoryboardScene.Message.messageList.instantiate()💡 Tip: to help you do this transition, you may be interested in using the "compatibility template" we suggest here. It will allow you to generate compatibility code for the old storyboard function calls, generating depreciation warnings + renaming fix-its for that SwiftGen 4.x API. This way you could then use Xcode's "Fix all in scope" feature to let Xcode do the renaming and migration for you!