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

Document Rule.errorForReadme

Browse Source
This commit is contained in:
Jeroen Engels 2020-03-20 19:54:21 +01:00
parent c674f97c55
commit 45ca6e2832
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/Review/Rule.elm
View File

@ -2436,13 +2436,17 @@ type ElmJsonKey
}
{-| Just like [`error`](#error), create an [`Error`](#Error) but for a specific module, instead of the module that is being
visited.
{-| Create an [`Error`](#Error) for the `elm.json` file.
You will need a [`ElmJsonKey`](#ElmJsonKey), which you can get from the [`withElmJsonProjectVisitor`](#withElmJsonProjectVisitor)
You will need an [`ElmJsonKey`](#ElmJsonKey), which you can get from the [`withElmJsonProjectVisitor`](#withElmJsonProjectVisitor)
function.
Fixes added to errors for the `elm.json` file are automatically ignored.
The second argument is a function that takes the `elm.json` content as a raw string,
and returns the error details. Using the raw string, you should try and find the
most fitting [`Range`](https://package.elm-lang.org/packages/stil4m/elm-syntax/7.1.0/Elm-Syntax-Range)
possible for the error.
**NOTE**: Fixes added to errors for the `elm.json` file are automatically ignored.
-}
errorForElmJson : ElmJsonKey -> (String -> { message : String, details : List String, range : Range }) -> Error
@ -2462,12 +2466,11 @@ errorForElmJson (ElmJsonKey { path, raw }) getErrorInfo =
}
{-| TODO Documentation
A key to be able to report an error for the `elm.json` file. You need this
key in order to use the [`errorForElmJson`](#errorForElmJson) function. This is
{-| A key to be able to report an error for the `README.md` file. You need this
key in order to use the [`errorForReadme`](#errorForReadme) function. This is
to prevent creating errors for it if you have not visited it.
You can get a `ElmJsonKey` using the [`withElmJsonProjectVisitor`](#withElmJsonProjectVisitor) function.
You can get a `ReadmeKey` using the [`withReadmeProjectVisitor`](#withReadmeProjectVisitor) function.
-}
type ReadmeKey
@ -2477,13 +2480,12 @@ type ReadmeKey
}
{-| Just like [`error`](#error), create an [`Error`](#Error) but for a specific module, instead of the module that is being
visited.
{-| Create an [`Error`](#Error) for the `README.md` file.
You will need a [`ElmJsonKey`](#ElmJsonKey), which you can get from the [`withElmJsonProjectVisitor`](#withElmJsonProjectVisitor)
You will need an [`ReadmeKey`](#ReadmeKey), which you can get from the [`withReadmeProjectVisitor`](#withReadmeProjectVisitor)
function.
Fixes added to errors for the `elm.json` file are automatically ignored.
**NOTE**: Fixes added to errors for the `README` file are automatically ignored.
-}
errorForReadme : ReadmeKey -> { message : String, details : List String } -> Range -> Error