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

Document expectErrorsForReadme

Browse Source
This commit is contained in:
Jeroen Engels 2020-03-20 19:47:12 +01:00
parent 023bbd60b5
commit c674f97c55
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/Review/Test.elm
View File

@ -699,8 +699,8 @@ expectErrorsForModules expectedErrorsList reviewResult =
|> Review.Test.expectErrorsForElmJson
[ Review.Test.error
{ message = "Unused dependency `author/package`"
, details = [ "Details about the error" ]
, under = "Debug.log"
, details = [ "Dependency should be removed" ]
, under = "author/package"
}
]
@ -723,8 +723,7 @@ expectErrorsForElmJson expectedErrors reviewResult =
expectErrorsForModules [ ( "elm.json", expectedErrors ) ] reviewResult
{-| TODO Documentation
Assert that the rule reported some errors for the `elm.json` file, by specifying which ones.
{-| Assert that the rule reported some errors for the `README.md` file, by specifying which ones.
test "report an error when a module is unused" <|
\() ->
@ -734,19 +733,19 @@ Assert that the rule reported some errors for the `elm.json` file, by specifying
|> Review.Test.runWithProjectData rule
|> Review.Test.expectErrorsForElmJson
[ Review.Test.error
{ message = "Unused dependency `author/package`"
, details = [ "Details about the error" ]
, under = "Debug.log"
{ message = "Invalid link"
, details = [ "README contains an invalid link" ]
, under = "htt://example.com"
}
]
Alternatively, or if you need to specify errors for other files too, you can use [`expectErrorsForModules`](#expectErrorsForModules), specifying `elm.json` as the module name.
Alternatively, or if you need to specify errors for other files too, you can use [`expectErrorsForModules`](#expectErrorsForModules), specifying `README.md` as the module name.
sourceCode
|> Review.Test.runOnModules rule
|> Review.Test.expectErrorsForModules
[ ( "ModuleB", [ Review.Test.error someErrorModuleB ] )
, ( "elm.json", [ Review.Test.error someErrorForElmJson ] )
, ( "README.md", [ Review.Test.error someErrorForReadme ] )
]
Assert which errors are reported using [`error`](#error). The test will fail if