« Changelog History


SwiftGen v6.0.0 Release Notes

Release Date: 2018-09-29 // about 5 years ago

  • 🚀 ⚠️ This major version is a big milestone in which a lot of refactoring and cleaning has been done. Many features added over previous releases have been reworked and unified, while also preparing SwiftGen for future additions. This means that you'll need to adapt your configuration files (or command line invocations) and custom templates to work with this new major version.

    📚 Read the SwiftGen 6.0 Migration Guide for a list of changes you'll need to apply.

    🔄 Changes in other SwiftGen modules

    💥 Breaking Changes

    • 🚚 Don't normalize string keys while parsing, let all transformation be done on template side. This makes the developer responsible to keep the language file organized, duplications won't be removed.
      Diego Chohfi
      #257
    • ✂ Remove Swift 2 support.
      David Jennes
      #420
    • 🚚 Renamed the storyboards command to ib, to better reflect it's purpose. An alias for storyboards still exists, but it will be removed at some point.
      David Jennes
      #423
    • 🍱 XCAssets: the generated templates won't namespace groups by default anymore, use the forceProvidesNamespaces flag to enable this behaviour again.
      jechris
      #453
    • 🍱 XCAssets: the templates won't generate any all-values accessors anymore by default. Use the allValues flag to enable this behaviour again. Note: this replaces the old noAllValues flag (with an inverse behaviour).
      David Jennes
      #480
    • 🍱 XCAssets: Dropped the deprecated allValues constant, use the type specific constants such as allColors, allDataItems and allImages. The default value of imageAlias has also been changed from Image to AssetImageTypeAlias, to be consistent with the other types.
      David Jennes
      #482
    • 🏗 Interface Builder: split up the storyboards template into 2 parts, one for scenes and one for segues.
      David Jennes
      #419

    🆕 New Features

    • ➕ Add ability to list all custom fonts and register them using FontFamily.registerAllCustomFonts.
      Olivier Halligon
      #394
    • ➕ Add support for Swift Package Manager and Mint.
      Yonas Kolb
      #411
    • 👕 The swiftgen.yml config file now accepts multiple outputs for each command, allowing you to generate multiple outputs from the same files and content. This also means that the output parameter is now deprecated, in favour of the outputs parameter, and it may be removed in a future version of SwiftGen. Similarly, the paths parameter has been renamed to inputs for consistency. You can always use swiftgen config lint to validate your configuration file.
      David Jennes
      #424
      #510
    • 👕 Use swiftlint:disable all in generated files to avoid interference with SwiftLint rules custom to the host project.
      Frederick Pietschmann
      David Jennes
      #409
      #506
    • 🍱 XCAssets: Added support for NSDataAssets.
      Oliver Jones
      #444
    • 👍 Organised the generated code in sections for better readability, with all generated constants at the top of the file.
      David Jennes
      Olivier Halligon
      #456
      #481
    • ➕ Added support for JSON, Plist and YAML files using the swiftgen json, swiftgen plist and swiftgen yaml commands. The parsed contexts and the generated files for each command have been kept quite similar, for easier switching between file formats.
      John T McIntosh
      Toshihiro Suzuki
      Peter Livesey
      David Jennes
      #379
      #359
      #288
      #188
      #493
      #504
    • ⚡️ Updated the playgrounds with the new json, plist and yaml commands, and updated the other pages to reflect the template changes.
      David Jennes
      #495
    • 🔧 We're deprecating the old --template CLI option in favor of --templateName, to better match the naming of the other options and the configuration file. The old --template option will remain until the next major version.
      David Jennes
      #509

    🐛 Bug Fixes

    • 🛠 Fix memory leak in generated code for Fonts.
      Olivier Halligon
      #394
    • 🏗 Interface Builder: ensure the templates handle GLKViewController, AVPlayerViewController and NSPageController correctly.
      David Jennes
      #404
      #414
    • 🏗 Interface Builder: ensure the parser can handle files with and without "trait variations".
      David Jennes
      #367
      #429
    • 🚚 Restrict SceneType and InitialSceneType to UIViewController when not targeting AppKit. When targeting AppKit, remove superfluous Any.
      Darron Schall
      #463
      #464
    • Fonts: disable a warning in generated font files for projects with conditional_returns_on_newlines SwiftLint rule enabled.
      Ryan Davies
      #436
      #465
    • 🏗 Interface Builder: the parser and templates now handle the "Inherit module from target" setting.
      David Jennes
      #435
      #485
    • 📜 Strings: the parser now correctly handles formats such as % d and %#x.
      David Jennes
      #502
    • Strings: ensure strings without arguments are not processed using String(format:).
      David Jennes
      #503

    Internal Changes