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

Report a global error when the path was custom but could not be found

Browse Source
This commit is contained in:
Jeroen Engels 2023-06-02 19:33:34 +02:00
parent b29d9f3fef
commit 91bfcb1baf
2 changed files with 57 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
tests/Docs/NoMissingChangelogEntry.elm
View File

@ -53,22 +53,27 @@ rule : Configuration -> Rule
rule (Configuration { changelogPath }) =
Rule.newProjectRuleSchema "Docs.NoMissingChangelogEntry" initialProjectContext
|> Rule.withElmJsonProjectVisitor elmJsonVisitor
|> Rule.withExtraFilesProjectVisitor [ changelogPath ] extraFilesVisitor
|> Rule.withExtraFilesProjectVisitor [ Maybe.withDefault defaultPath changelogPath ] (extraFilesVisitor changelogPath)
|> Rule.fromProjectRuleSchema
type Configuration
= Configuration { changelogPath : String }
= Configuration { changelogPath : Maybe String }
defaults : Configuration
defaults =
Configuration { changelogPath = "CHANGELOG.md" }
Configuration { changelogPath = Nothing }
defaultPath : String
defaultPath =
"CHANGELOG.md"
withPathToChangelog : String -> Configuration -> Configuration
withPathToChangelog changelogPath _ =
Configuration { changelogPath = changelogPath }
Configuration { changelogPath = Just changelogPath }
type alias ProjectContext =
@ -98,8 +103,8 @@ elmJsonVisitor maybeElmJsonData context =
( [], context )
extraFilesVisitor : List { path : String, content : String } -> ProjectContext -> ( List (Rule.Error { useErrorForModule : () }), ProjectContext )
extraFilesVisitor files context =
extraFilesVisitor : Maybe String -> List { path : String, content : String } -> ProjectContext -> ( List (Rule.Error { useErrorForModule : () }), ProjectContext )
extraFilesVisitor changelogPath files context =
case List.head files of
Just { content } ->
if String.contains context.elmJsonVersion content then
@ -115,19 +120,33 @@ extraFilesVisitor files context =
)
Nothing ->
( [ Rule.globalError
{ message = "Could not find the CHANGELOG.md file"
, details =
[ "I was looking for the CHANGELOG.md file next to your project's elm.json file but couldn't find it. Please make sure that the spelling is correct."
, "If your changelog is named differently or is in a different location, then you can configure this rule to look for it in a different location:"
, """ config =
case changelogPath of
Nothing ->
( [ Rule.globalError
{ message = "Could not find the CHANGELOG.md file"
, details =
[ "I was looking for the CHANGELOG.md file next to your project's elm.json file but couldn't find it. Please make sure that the spelling is correct."
, "If your changelog is named differently or is in a different location, then you can configure this rule to look for it in a different location:"
, """ config =
[ Docs.NoMissingChangelogEntry.defaults
|> Docs.NoMissingChangelogEntry.changelogPath "path/to/your/changelog.md"
|> Docs.NoMissingChangelogEntry.withPathToChangelog "path/to/your/changelog.md"
|> Docs.NoMissingChangelogEntry.rule
]"""
, "Note that the path is relative your project's elm.json file."
]
}
]
, context
)
, "Note that the path is relative your project's elm.json file."
]
}
]
, context
)
Just customPath ->
( [ Rule.globalError
{ message = "Could not find the " ++ customPath ++ " changelog file"
, details =
[ "I was looking for the " ++ customPath ++ " changelog file but couldn't find it. Please make sure that the path you specified through Docs.NoMissingChangelogEntry.withPathToChangelog is correct."
, "Also note that the path you specify has to be relative to your project's elm.json file."
]
}
]
, context
)

24
tests/Docs/NoMissingChangelogEntryTest.elm
View File

@ -1,6 +1,6 @@
module Docs.NoMissingChangelogEntryTest exposing (all)
import Docs.NoMissingChangelogEntry exposing (rule)
import Docs.NoMissingChangelogEntry exposing (defaults, rule, withPathToChangelog)
import Elm.Project
import Json.Decode as Decode
import Review.Project as Project exposing (Project)
@ -30,7 +30,7 @@ Stuff happened
package
in
"module A exposing (..)\na = 1"
|> Review.Test.runWithProjectData project (rule Docs.NoMissingChangelogEntry.defaults)
|> Review.Test.runWithProjectData project (rule defaults)
|> Review.Test.expectNoErrors
, test "should report an error when the version in the elm.json is not found in the changelog" <|
\() ->
@ -53,7 +53,7 @@ Stuff happened
"""module A exposing (..)
a = 1
"""
|> Review.Test.runWithProjectData project (rule Docs.NoMissingChangelogEntry.defaults)
|> Review.Test.runWithProjectData project (rule defaults)
|> Review.Test.expectGlobalErrors
[ { message = "Missing entry in CHANGELOG.md for version 2.13.0"
, details = [ "It seems you have or are ready to release a new version of your package, but forgot to include releases notes for it in your CHANGELOG.md file." ]
@ -64,7 +64,7 @@ a = 1
"""module A exposing (..)
a = 1
"""
|> Review.Test.runWithProjectData package (rule Docs.NoMissingChangelogEntry.defaults)
|> Review.Test.runWithProjectData package (rule defaults)
|> Review.Test.expectGlobalErrors
[ { message = "Could not find the CHANGELOG.md file"
, details =
@ -72,13 +72,27 @@ a = 1
, "If your changelog is named differently or is in a different location, then you can configure this rule to look for it in a different location:"
, """ config =
[ Docs.NoMissingChangelogEntry.defaults
|> Docs.NoMissingChangelogEntry.changelogPath "path/to/your/changelog.md"
|> Docs.NoMissingChangelogEntry.withPathToChangelog "path/to/your/changelog.md"
|> Docs.NoMissingChangelogEntry.rule
]"""
, "Note that the path is relative your project's elm.json file."
]
}
]
, test "should report an error when the changelog could not be found (custom path)" <|
\() ->
"""module A exposing (..)
a = 1
"""
|> Review.Test.runWithProjectData package (defaults |> withPathToChangelog "path/not-found.md" |> rule)
|> Review.Test.expectGlobalErrors
[ { message = "Could not find the path/not-found.md changelog file"
, details =
[ "I was looking for the path/not-found.md changelog file but couldn't find it. Please make sure that the path you specified through Docs.NoMissingChangelogEntry.withPathToChangelog is correct."
, "Also note that the path you specify has to be relative to your project's elm.json file."
]
}
]
]