jfmengels/elm-review
1
1
Fork 0
mirror of https://github.com/jfmengels/elm-review.git synced 2024-11-27 12:08:51 +03:00
Code Issues Packages Projects Releases Wiki Activity

v2.2.0

Browse Source
This commit is contained in:
Jeroen Engels 2020-06-20 17:52:17 +02:00
parent b98f83d5f9
commit 91f92d4291
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -4,7 +4,7 @@
`elm-review` analyzes [Elm](https://elm-lang.org/) projects, to help find mistakes before your users find them. `elm-review` analyzes [Elm](https://elm-lang.org/) projects, to help find mistakes before your users find them.
[![elm-review reporter output](https://github.com/jfmengels/elm-review/blob/2.0.1/documentation/images/elm-review-report.png?raw=true)](https://github.com/jfmengels/elm-review/blob/2.0.1/documentation/images/elm-review-report-hq.png?raw=true) [![elm-review reporter output](https://github.com/jfmengels/elm-review/blob/2.2.0/documentation/images/elm-review-report.png?raw=true)](https://github.com/jfmengels/elm-review/blob/2.0.1/documentation/images/elm-review-report-hq.png?raw=true)
## What does `elm-review` do? ## What does `elm-review` do?
@ -75,7 +75,7 @@ Before you start adding rules though, I suggest reading the rest of this documen
## Write your own rule ## Write your own rule
You can write your own rule using this package's API and [`elm-syntax`](https://package.elm-lang.org/packages/stil4m/elm-syntax/7.1.0/). You can write your own rule using this package's API and [`elm-syntax`](https://package.elm-lang.org/packages/stil4m/elm-syntax/7.1.0/).
Check out the [`Review.Rule`](https://package.elm-lang.org/packages/jfmengels/elm-review/2.1.1/Review-Rule) documentation for how to get started. Check out the [`Review.Rule`](https://package.elm-lang.org/packages/jfmengels/elm-review/2.2.0/Review-Rule) documentation for how to get started.
Here's an example of a rule that prevents a typo in a string that was made too often at your company. Here's an example of a rule that prevents a typo in a string that was made too often at your company.
@ -124,8 +124,8 @@ Then add the rule in your configuration:
```elm ```elm
module ReviewConfig exposing (config) module ReviewConfig exposing (config)
import Review.Rule exposing (Rule)
import NoStringWithMisspelledCompanyName import NoStringWithMisspelledCompanyName
import Review.Rule exposing (Rule)
config : List Rule config : List Rule
@ -174,7 +174,7 @@ When wondering whether to enable a rule, I suggest using this checklist:
## Is there a way to ignore an error or disable a rule only in some locations? ## Is there a way to ignore an error or disable a rule only in some locations?
You can prevent errors from being reported by either changing the implementation of your rules or by [configuring exceptions](https://package.elm-lang.org/packages/jfmengels/elm-review/2.1.1/Review-Rule#configuring-exceptions) for directories or for files. You can prevent errors from being reported by either changing the implementation of your rules or by [configuring exceptions](https://package.elm-lang.org/packages/jfmengels/elm-review/2.2.0/Review-Rule#configuring-exceptions) for directories or for files.
It is however not possible to ignore errors on a case-by-case basis, for several reasons: It is however not possible to ignore errors on a case-by-case basis, for several reasons:

2
elm.json
View File

@ -3,7 +3,7 @@
"name": "jfmengels/elm-review", "name": "jfmengels/elm-review",
"summary": "Analyzes Elm projects, to help find mistakes before your users find them.", "summary": "Analyzes Elm projects, to help find mistakes before your users find them.",
"license": "BSD-3-Clause", "license": "BSD-3-Clause",
"version": "2.1.1", "version": "2.2.0",
"exposed-modules": [ "exposed-modules": [
"Review.Rule", "Review.Rule",
"Review.Project", "Review.Project",