Merge pull request SwiftGen#546 from SwiftGen/release/6.0.2

Release/6.0.2

Author: AliSoftware

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,5 +1,6 @@
 * [ ] I've started my branch from the `develop` branch (gitflow)
-* [ ] I've added an entry in the `CHANGELOG.md` file to explain my changes and credit myself
+* [ ] I've added an entry in the `CHANGELOG.md` file to explain my changes and credit myself  
+      _(or added `#trivial` to the PR title if I think it doesn't warrant a mention in the CHANGELOG)_
   * [ ] Add the entry in the appropriate section (Bug Fix / New Feature / Breaking Change / Internal Change)
   * [ ] Add a period and 2 spaces at the end of your short entry description
   * [ ] Add links to your GitHub profile to credit yourself and to the related PR and issue after your description

CHANGELOG.md

@@ -2,6 +2,25 @@
 
 ---
 
+## 6.0.2
+
+### Changes in other SwiftGen modules
+
+* [StencilSwiftKit 2.7.1](https://github.com/SwiftGen/StencilSwiftKit/blob/2.7.1/CHANGELOG.md)
+* [Stencil 0.13.1](https://github.com/kylef/Stencil/blob/0.13.1/CHANGELOG.md)
+
+### Bug Fixes
+
+* Strings: rolled back the changes in #503, to ensure `%%` is correctly unescaped.  
+  [David Jennes](https://github.com/djbe)
+  [#542](https://github.com/SwiftGen/SwiftGen/pull/542)
+* Strings: generate the correct types for `%c` and `%p`.  
+  [David Jennes](https://github.com/djbe)
+  [#543](https://github.com/SwiftGen/SwiftGen/pull/543)
+* SPM/Mint: SwiftGen now provides correct version information, instead of "0.0".  
+  [David Jennes](https://github.com/djbe)
+  [#544](https://github.com/SwiftGen/SwiftGen/pull/544)
+
 ## 6.0.1
 
 ### Changes in other SwiftGen modules
@@ -22,15 +41,17 @@
 * SPM/Mint: Update the Stencil version to 0.13.1.  
   [David Jennes](https://github.com/djbe)
   [#527](https://github.com/SwiftGen/SwiftGen/pull/527)
-* Ensure the `templates` subcommand properly works with the deprecated `storyboards` subcommand.
+* Ensure the `templates` subcommand properly works with the deprecated `storyboards` subcommand.  
   [David Jennes](https://github.com/djbe)
-  [#529](https://github.com/SwiftGen/SwiftGen/pull/529)
+  [#525](https://github.com/SwiftGen/SwiftGen/issues/525)
+  [#530](https://github.com/SwiftGen/SwiftGen/pull/530)
 * Ensure configuration file errors show as red in Xcode.  
   [Olivier Halligon](https://github.com/AliSoftware)
-  [#533](https://github.com/SwiftGen/SwiftGen/pull/533)
   [#516](https://github.com/SwiftGen/SwiftGen/issues/516)
+  [#533](https://github.com/SwiftGen/SwiftGen/pull/533)
 * Strings: Ensure the parser correctly handles keys ending with a `.` and empty key components.  
   [David Jennes](https://github.com/djbe)
+  [#528](https://github.com/SwiftGen/SwiftGen/issues/528)
   [#531](https://github.com/SwiftGen/SwiftGen/pull/531)
 
 ### Internal Changes
@@ -163,20 +184,20 @@ Read the [SwiftGen 6.0 Migration Guide](Documentation/MigrationGuide.md#swiftgen
   [#402](https://github.com/SwiftGen/SwiftGen/pull/402)
   [#476](https://github.com/SwiftGen/SwiftGen/pull/476)
 * Updated to latest Xcode (10.0.0) and Swift 4.2.  
-  [David Jennes](https://github.com/djbe) 
+  [David Jennes](https://github.com/djbe)
   [#415](https://github.com/SwiftGen/SwiftGen/pull/415)
   [#498](https://github.com/SwiftGen/SwiftGen/pull/498)
 * Update to Stencil 0.13.0, and use some of it's new filters in our templates.  
-  [David Jennes](https://github.com/djbe) 
+  [David Jennes](https://github.com/djbe)
   [#416](https://github.com/SwiftGen/SwiftGen/pull/416)
   [#475](https://github.com/SwiftGen/SwiftGen/pull/475)
   [#498](https://github.com/SwiftGen/SwiftGen/pull/498)
 * Store testing contexts as YAML files instead of PLISTs.  
-  [David Jennes](https://github.com/djbe) 
+  [David Jennes](https://github.com/djbe)
   [#418](https://github.com/SwiftGen/SwiftGen/pull/418)
   [#461](https://github.com/SwiftGen/SwiftGen/pull/461)
 * Refactor the parsers as they're getting more complex.  
-  [David Jennes](https://github.com/djbe) 
+  [David Jennes](https://github.com/djbe)
   [#417](https://github.com/SwiftGen/SwiftGen/pull/417)
   [#422](https://github.com/SwiftGen/SwiftGen/pull/422)
 * Disabled a SwiftLint rule for function parameter count.  
@@ -232,7 +253,7 @@ Read the [SwiftGen 6.0 Migration Guide](Documentation/MigrationGuide.md#swiftgen
 
 ### Changes in other SwiftGen modules
 
-* [SwiftGenKit 2.1.1](https://github.com/SwiftGen/SwiftGenKit/blob/2.1.1/CHANGELOG.md)  
+* [SwiftGenKit 2.1.1](https://github.com/SwiftGen/SwiftGenKit/blob/2.1.1/CHANGELOG.md)
 * [StencilSwiftKit 2.3.0](https://github.com/SwiftGen/StencilSwiftKit/blob/2.3.0/CHANGELOG.md)
 * [templates 2.2.0](https://github.com/SwiftGen/templates/blob/2.2.0/CHANGELOG.md)
 
@@ -501,7 +522,7 @@ Note: The next minor version will focus on bringing more documentation for all t
    which offers the same functionality.  
   [David Jennes](https://github.com/djbe)
   [#243](https://github.com/SwiftGen/SwiftGen/pull/243)
-* Support multiple input paths for some commands:  
+* Support multiple input paths for some commands.  
   [David Jennes](https://github.com/djbe)
   [#213](https://github.com/SwiftGen/SwiftGen/pull/213)
   * `fonts` accepts multiple input directories, all found fonts will be added
@@ -569,7 +590,7 @@ Note: The next minor version will focus on bringing more documentation for all t
   developement, for easier debugging in Xcode.  
   [ahtierney](https://github.com/ahtierney)
   [#204](https://github.com/SwiftGen/SwiftGen/pull/204)
-* Consolidate the use of PathKit internally.    
+* Consolidate the use of PathKit internally.  
   [David Jennes](https://github.com/djbe)
   [#212](https://github.com/SwiftGen/SwiftGen/pull/212)
 * Updated Stencil to [0.7.2](https://github.com/kylef/Stencil/releases/tag/0.7.0).  
@@ -593,7 +614,7 @@ Note: The next minor version will focus on bringing more documentation for all t
   ensuring that the parser correctly handles namespaced folders.  
   ⚠️ Note that you now have to specify the exact path to your `.xcassets` assets catalogs
   when using `swiftgen images` (and not just a directory to parse).  
-  [David Jennes](https://github.com/djbe)
+  [David Jennes](https://github.com/djbe)
   [#199](https://github.com/SwiftGen/SwiftGen/pull/199)
 
 ### New Features
@@ -612,7 +633,7 @@ Note: The next minor version will focus on bringing more documentation for all t
 ## 3.0.1
 
 * Add support for Xcode 8 and Swift 2.3.  
-  _(Should still compile in Xcode 7.3 but the `Rakefile` to build, install and release requires Xcode 8)._  
+  _(Should still compile in Xcode 7.3 but the `Rakefile` to build, install and release requires Xcode 8)_.  
   [Valentin Knabel](https://github.com/vknabel)
   [Ignacio Romero Zurbuchen](https://github.com/dzenbot)
   [HanxuanZhou](https://github.com/GenoZhou)
@@ -660,7 +681,7 @@ Note: The next minor version will focus on bringing more documentation for all t
 * Now reports an error when it failed to parse a color in a color input file.  
   [Olivier Halligon](https://github.com/AliSoftware)
   [#162](https://github.com/SwiftGen/SwiftGen/issues/162)
-* New Strings template (available via `-t dot-syntax`), allowing string keys containing dots (like foo.bar.baz) to be organized as a hierarchy and accessible via dot syntax.
+* New Strings template (available via `-t dot-syntax`), allowing string keys containing dots (like foo.bar.baz) to be organized as a hierarchy and accessible via dot syntax.  
   [Cihat Gündüz](https://github.com/Dschee)
   [#159](https://github.com/SwiftGen/SwiftGen/pull/159)
 * Update Swift 3 templates to use lowercase enums.  
@@ -680,14 +701,12 @@ Note: The next minor version will focus on bringing more documentation for all t
 
 ### Important Notes
 
-* Some keys for various templates have changed to provide more flexibility and enable some new features in the templates. As a result, **if you created your own custom templates, they might not all be totally compatible with SwiftGen 3.0.0** (hence the new major version).
+- Some keys for various templates have changed to provide more flexibility and enable some new features in the templates. As a result, **if you created your own custom templates, they might not all be totally compatible with SwiftGen 3.0.0** (hence the new major version).
 Please read the [Custom Templates documentation](documentation/Templates.md) to find out the new Stencil context keys and update your custom templates accordingly.
 
 _If you're using one of the bundled templates, all of them have been updated appropriately._
 
-* Also **if you use Swift 3**, and thus use the `-t swift3` flag to use the Swift 3 templates, be advised those has been modified
-to take the latest Swift 3 modifications into account (including naming convensions) so your code might need to be updated
-according to match the latest Swift 3 recommendations.
+- Also **if you use Swift 3**, and thus use the `-t swift3` flag to use the Swift 3 templates, be advised those has been modified to take the latest Swift 3 modifications into account (including naming convensions) so your code might need to be updated according to match the latest Swift 3 recommendations.
 
 ## 2.0.0
 
@@ -752,10 +771,10 @@ stop working as expected. That's the main reason why the version has been bumped
 * Added support for TXT (`colors.txt`) files to have named value.  
   [Derek Ostrander](https://github.com/dostrander)
   [#118](https://github.com/SwiftGen/SwiftGen/pull/118)
-* Restructured image templates to work around an LLVM issue with nested types.    
+* Restructured image templates to work around an LLVM issue with nested types.  
   [Ken Grigsby](https://github.com/kgrigsby59)
   [#112](https://github.com/SwiftGen/SwiftGen/issues/112)
-* Added Swift 3 templates for storyboards and strings.    
+* Added Swift 3 templates for storyboards and strings.  
   [Andrew Breckenridge](https://github.com/AndrewSB)
   [#117](https://github.com/SwiftGen/SwiftGen/pull/117)
 
@@ -832,10 +851,10 @@ stop working as expected. That's the main reason why the version has been bumped
 
 #### Enhancements
 
-* Adding comments to generated color enums which allow you to see the color in the QuickHelp documentation
+* Adding comments to generated color enums which allow you to see the color in the QuickHelp documentation.  
 
 * The default translation of strings are now added as documentation comments to the enum cases.  
-  _You can add translations to your own templates by using the `string.translation` variable._  
+  _You can add translations to your own templates by using the `string.translation` variable_.  
   [@MrAlek](https://github.com/MrAlek)
   [#58](https://github.com/SwiftGen/SwiftGen/issues/58)
   [#60](https://github.com/SwiftGen/SwiftGen/pull/60)
@@ -884,7 +903,8 @@ SwiftGen now comes bundled with some alternate templates, especially `colors-raw
   [Viacheslav Karamov](https://github.com/vkaramov/)
   [#48](https://github.com/SwiftGen/SwiftGen/issues/48)
 * Introduced an `image-allvalues` template that exposes the list of all images in a `static let allValues` array.  
-  [Ahmed Mseddi](https://github.com/amseddi) & Guillaume Lagorce
+  [Ahmed Mseddi](https://github.com/amseddi)
+  & Guillaume Lagorce
   [#44](https://github.com/SwiftGen/SwiftGen/pull/44)
 * Fix issue with Storyboards without any StoryboardID (all scenes being anonymous) not extending `StoryboardScene`.  
   [#36](https://github.com/SwiftGen/SwiftGen/issues/36)
@@ -894,8 +914,8 @@ SwiftGen now comes bundled with some alternate templates, especially `colors-raw
 ### New Features: Templates
 
 * `SwiftGen` now uses [Stencil](https://github.com/kylef/Stencil) template engine to produce the generated code.
-* This means that the generate code will be easier to improve
-* This also means that **you can use your own templates** to generate code that better suits your needs and preferences, using `swiftgen … --template FILE …`
+* This means that the generate code will be easier to improve.
+* This also means that **you can use your own templates** to generate code that better suits your needs and preferences, using `swiftgen … --template FILE …`.
 
 ### Fixes
 
@@ -935,7 +955,7 @@ SwiftGen now comes bundled with some alternate templates, especially `colors-raw
 
 #### Fixes
 
-* Fix color parsing with absent alpha  
+* Fix color parsing with absent alpha.  
   [@Igor-Palaguta](https://github.com/Igor-Palaguta)
   [#28](https://github.com/SwiftGen/SwiftGen/pull/28)
 

Dangerfile

@@ -1,5 +1,11 @@
+require_relative 'rakelib/check_changelog'
+
 # Welcome message
-markdown("Hey 👋 I'm Eve, the friendly bot watching over SwiftGen 🤖\nThanks a lot for your contribution!")
+markdown [
+  "Hey 👋 I'm Eve, the friendly bot watching over SwiftGen 🤖",
+  "Thanks a lot for your contribution!",
+  '', '---', ''
+]
 
 # Make it more obvious that a PR is a work in progress and shouldn't be merged yet
 warn('PR is classed as Work in Progress') if github.pr_title.include? '[WIP]'
@@ -9,11 +15,6 @@ warn('Big PR') if git.lines_of_code > 500
 
 need_fixes = []
 
-# Check for a CHANGELOG entry
-declared_trivial = github.pr_title.include? '#trivial'
-has_changelog = git.modified_files.include?('CHANGELOG.md') || declared_trivial
-need_fixes << warn('Please add a CHANGELOG entry to credit your work') unless has_changelog
-
 # Check for correct base branch
 is_release = github.branch_for_head.start_with?('release/')
 to_develop = github.branch_for_base == 'develop'
@@ -31,7 +32,7 @@ if is_release
     '',
     stdout
   ]
-  need_fixes << warn('Please fix the CHANGELOG errors') unless status.success?
+  need_fixes << fail('Please fix the CHANGELOG errors') unless status.success?
 
   stdout, _, status = Open3.capture3('bundle', 'exec', 'rake', 'release:check_versions')
   markdown [
@@ -40,9 +41,9 @@ if is_release
     '',
     stdout
   ]
-  need_fixes << warn('Please fix the versions inconsistencies') unless status.success?
+  need_fixes << fail('Please fix the versions inconsistencies') unless status.success?
 elsif !to_develop
-  need_fixes << warn("Feature branches should start from and be merged into 'develop', " \
+  need_fixes << fail("Feature branches should start from and be merged into 'develop', " \
     "not #{github.branch_for_base}")
 end
 
@@ -53,11 +54,47 @@ if podfile_changed ^ package_changed
   need_fixes << warn("You should make sure that `Podfile.lock` and `Package.resolved` are changed in sync")
 end
 
+
+# Check for a CHANGELOG entry
+declared_trivial = github.pr_title.include? '#trivial'
+has_changelog = git.modified_files.include?('CHANGELOG.md')
+changelog_msg = ''
+unless has_changelog || declared_trivial
+  repo_url = github.pr_json['head']['repo']['html_url']
+  pr_title = github.pr_title
+  pr_title += '.' unless pr_title.end_with?('.')
+  pr_number = github.pr_json['number']
+  pr_url = github.pr_json['html_url']
+  pr_author = github.pr_author
+  pr_author_url = "https://github.com/#{pr_author}"
+
+  need_fixes = fail("Please include a CHANGELOG entry to credit your work.  \nYou can find it at [CHANGELOG.md](#{repo_url}/blob/master/CHANGELOG.md).")
+
+  changelog_msg = <<-CHANGELOG_FORMAT.gsub(/^ *\|/,'')
+  |📝 We use the following format for CHANGELOG entries:
+  |```
+  | * #{pr_title}  
+  |   [##{pr_number}](#{pr_url})
+  |   [@#{pr_author}](#{pr_author_url})
+  |```
+  |:bulb: Don't forget to end the line describing your changes by a period and two spaces.
+  CHANGELOG_FORMAT
+  # changelog_msg is printed during the "Encouragement message" section, see below
+end
+
+changelog_warnings = check_changelog()
+unless changelog_warnings.empty?
+  need_fixes << warn('Found some warnings in CHANGELOG.md')
+  changelog_warnings.each do |warning|
+    warn(warning[:message], file: 'CHANGELOG.md', line: warning[:line])
+  end
+end
+
 # Encouragement message
-markdown ['', '---', '']
 if need_fixes.empty?
   markdown('Seems like everything is in order 👍 You did a good job here! 🤝')
 else
   markdown('Once you fix those tiny nitpickings above, we should be good to go! 🙌')
-  markdown('_Note: I will update this comment as you add new commits_')
+  markdown(changelog_msg) unless changelog_msg.empty?
+  markdown('ℹ️ _I will update this comment as you add new commits_')
 end

Package.resources

@@ -1 +1,5 @@
 templates
+Resources/Stencil-Info.plist
+Resources/StencilSwiftKit-Info.plist
+Resources/SwiftGen-Info.plist
+Resources/SwiftGenKit-Info.plist

Podfile

@@ -29,3 +29,13 @@ target 'SwiftGenKit' do
     inherit! :complete
   end
 end
+
+post_install do | installer |
+  require 'fileutils'
+
+  # copy Info.plist files
+  pods_with_info_plist = %w(Stencil StencilSwiftKit)
+  pods_with_info_plist.each do |pod|
+    FileUtils.cp_r("Pods/Target Support Files/#{pod}/Info.plist", "Resources/#{pod}-Info.plist")
+  end
+end

Podfile.lock

@@ -36,6 +36,6 @@ SPEC CHECKSUMS:
   SwiftLint: 3207c1faa2240bf8973b191820a116113cd11073
   Yams: 572f625a8b719b73e0b57fd313c680f3e2161fe9
 
-PODFILE CHECKSUM: 8e3111566e6b6e5511458f90b27ca65d39072e1f
+PODFILE CHECKSUM: 5014c284f8c125f798aaf9f345c7fd79c645f4e9
 
 COCOAPODS: 1.5.3

Pods/Manifest.lock

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>CFBundleDevelopmentRegion</key>
+  <string>en</string>
+  <key>CFBundleExecutable</key>
+  <string>${EXECUTABLE_NAME}</string>
+  <key>CFBundleIdentifier</key>
+  <string>${PRODUCT_BUNDLE_IDENTIFIER}</string>
+  <key>CFBundleInfoDictionaryVersion</key>
+  <string>6.0</string>
+  <key>CFBundleName</key>
+  <string>${PRODUCT_NAME}</string>
+  <key>CFBundlePackageType</key>
+  <string>FMWK</string>
+  <key>CFBundleShortVersionString</key>
+  <string>0.13.1</string>
+  <key>CFBundleSignature</key>
+  <string>????</string>
+  <key>CFBundleVersion</key>
+  <string>${CURRENT_PROJECT_VERSION}</string>
+  <key>NSPrincipalClass</key>
+  <string></string>
+</dict>
+</plist>

Resources/Stencil-Info.plist

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>CFBundleDevelopmentRegion</key>
+  <string>en</string>
+  <key>CFBundleExecutable</key>
+  <string>${EXECUTABLE_NAME}</string>
+  <key>CFBundleIdentifier</key>
+  <string>${PRODUCT_BUNDLE_IDENTIFIER}</string>
+  <key>CFBundleInfoDictionaryVersion</key>
+  <string>6.0</string>
+  <key>CFBundleName</key>
+  <string>${PRODUCT_NAME}</string>
+  <key>CFBundlePackageType</key>
+  <string>FMWK</string>
+  <key>CFBundleShortVersionString</key>
+  <string>2.7.1</string>
+  <key>CFBundleSignature</key>
+  <string>????</string>
+  <key>CFBundleVersion</key>
+  <string>${CURRENT_PROJECT_VERSION}</string>
+  <key>NSPrincipalClass</key>
+  <string></string>
+</dict>
+</plist>