From 6b00203311c59fab1532a0ab96db7458df5d4c4e Mon Sep 17 00:00:00 2001 From: David Jennes Date: Wed, 17 May 2017 12:26:45 +0200 Subject: [PATCH 1/3] Provide migration guide --- Documentation/MigrationGuide.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 Documentation/MigrationGuide.md diff --git a/Documentation/MigrationGuide.md b/Documentation/MigrationGuide.md new file mode 100644 index 00000000..ba66290a --- /dev/null +++ b/Documentation/MigrationGuide.md @@ -0,0 +1,21 @@ +## StencilSwiftKit 2.0 (SwiftGen 5.0) ## + +### For template writers: + +* We've removed our `join` array filter as Stencil provides it's own version that accepts a parameter. If you were using StencilSwiftKit's version, replace instances of: +```{{ myArray|join }}``` +with: +```{{ myArray|join:", " }}``` +* We've refactored our `snakeToCamelCase` to accept arguments, thus removing the need for `snakeToCamelCaseNoPrefix`. If you were using the latter, replace instances of: +```{{ myValue|snakeToCamelCaseNoPrefix }}``` +with: +```{{ myValue|snakeToCamelCase:true }}``` + +### For developers: + +We've removed the following deprecated `typealias`es: + +* `FilterError`: use `Filters.Error` instead. +* `ParametersError`: use `Parameters.Error` instead. +* `NumFilters`: use `Filters.Numbers` instead. +* `StringFilters`: use `Filters.Strings` instead. From 76bcec920947ebc38878ac92e04993610b3a5c6f Mon Sep 17 00:00:00 2001 From: David Jennes Date: Thu, 18 May 2017 15:05:50 +0200 Subject: [PATCH 2/3] point changelog to migration guide --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d004dfd..d9804f72 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,9 @@ ## Master +Due to the removal of legacy code, there are a few breaking changes in this new version that affect both template writers as well as developers. We've provided a migration guide to help you through these changes, which you can find here: +[Migration Guide for 2.0](https://github.com/SwiftGen/StencilSwiftKit/blob/master/Documentation/MigrationGuide.md#stencilswiftkit-20-swiftgen-50) + ### Bug Fixes _None_ From f1adbaf3aaa75f8eeb5c7d9154665f9155a96ed2 Mon Sep 17 00:00:00 2001 From: David Jennes Date: Mon, 22 May 2017 02:11:05 +0200 Subject: [PATCH 3/3] small title clarification --- Documentation/MigrationGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/MigrationGuide.md b/Documentation/MigrationGuide.md index ba66290a..890bd635 100644 --- a/Documentation/MigrationGuide.md +++ b/Documentation/MigrationGuide.md @@ -11,7 +11,7 @@ with: with: ```{{ myValue|snakeToCamelCase:true }}``` -### For developers: +### For developers using StencilSwiftKit as a dependency: We've removed the following deprecated `typealias`es: