jfmengels/elm-review
1
1
Fork 0
mirror of https://github.com/jfmengels/elm-review.git synced 2024-11-22 13:15:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

Migration: Talk about v1 stopping working

Browse Source
This commit is contained in:
Jeroen Engels 2020-04-08 18:07:22 +02:00
parent a98dce088f
commit 8e35ac4cd5
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
documentation/Migration v1 to v2.md
View File

@ -1,7 +1,31 @@
# Migration from v1 to v2 # Migration from v1 to v2
## I CAN'T RUN ELM-REVIEW V1 ANYMORE!
If you are trying to run v1 of the `elm-review` CLI and it suddenly stopped working, I am very sorry about that!
Fortunately, there is an easy fix: updating the CLI to version `1.0.2`.
```
npm install -D elm-review@1.0.2
```
The problem is that previous versions try to build an application behind the scenes, and installs the `jfmengels/elm-review` package every time.
Those versions were not saying **which** version of `jfmengels/elm-review` to use though, due to limitations of what `elm install` offered and `elm-json` offered at the time.
And now that v2 has been released, well it may well try to install a version of `jfmengels/elm-review` that doesn't work for your project.
But `elm-json`'s author @zwilias was very responsive to this need, and version `1.0.2` now installs `jfmengels/elm-review` `1.0.0 <= x < 2.0.0`. So kudos to him!
## Rule writing ## Rule writing
The API for the rules you created in v1 is pretty much the same in v2.
The differences are mostly functions and types that were renamed, and a single argument somewhere to add.
You fortunately won't have to change anything in the logic of your rule or tests.
- [`newSchema`] is renamed to [`newModuleRuleSchema`]. It now takes the initial context as a new argument. If you were using [`withInitialContext`], then you should use that function's value, otherwise you can use `()`. - [`newSchema`] is renamed to [`newModuleRuleSchema`]. It now takes the initial context as a new argument. If you were using [`withInitialContext`], then you should use that function's value, otherwise you can use `()`.
- [`fromSchema`] is renamed to [`fromModuleRuleSchema`] - [`fromSchema`] is renamed to [`fromModuleRuleSchema`]
- [`withInitialContext`] has been removed, since the initial context is now supplied by [`newModuleRuleSchema`] - [`withInitialContext`] has been removed, since the initial context is now supplied by [`newModuleRuleSchema`]