Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide migration guide #42

Merged
merged 4 commits into from
May 22, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

* Fix `snakeToCamelCase` parameters information in README.
Expand Down
21 changes: 21 additions & 0 deletions Documentation/MigrationGuide.md
Original file line number Diff line number Diff line change
@@ -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 using StencilSwiftKit as a dependency:

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.