Add Documentation.ReadmeLinksPointToCurrentVersion to the review config

This commit is contained in:
Jeroen Engels 2020-04-04 00:53:34 +02:00
parent b478d2d374
commit 37732cad9f
3 changed files with 6 additions and 4 deletions

View File

@ -75,7 +75,7 @@ Before you start adding rules though, I suggest reading the rest of this documen
## 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/latest/).
Check out the [`Review.Rule`](https://package.elm-lang.org/packages/jfmengels/elm-review/latest/Review-Rule) documentation for more instructions.
Check out the [`Review.Rule`](https://package.elm-lang.org/packages/jfmengels/elm-review/1.0.0/Review-Rule) documentation for more instructions.
Here's an example of a rule that prevents a typo in a string that was made too often at your company.
@ -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?
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/latest/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/1.0.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:

View File

@ -11,9 +11,9 @@ when inside the directory containing this file.
-}
import Documentation.ReadmeLinksPointToCurrentVersion
import NoDebug.Log
import NoDebug.TodoOrToString
import NoTodoComment
import NoUnused.CustomTypeConstructors
import NoUnused.Dependencies
import NoUnused.Exports
@ -24,7 +24,8 @@ import Review.Rule as Rule exposing (Rule)
config : List Rule
config =
[ NoDebug.Log.rule
[ Documentation.ReadmeLinksPointToCurrentVersion.rule
, NoDebug.Log.rule
, NoDebug.TodoOrToString.rule
|> Rule.ignoreErrorsForDirectories [ "tests/" ]
, NoUnused.CustomTypeConstructors.rule

View File

@ -10,6 +10,7 @@
"elm/core": "1.0.2",
"elm/json": "1.1.3",
"elm/project-metadata-utils": "1.0.0",
"elm/regex": "1.0.0",
"elm-community/graph": "6.0.0",
"elm-community/intdict": "3.0.0",
"stil4m/elm-syntax": "7.1.0"