mirror of
https://github.com/jfmengels/elm-review.git
synced 2024-12-25 18:51:41 +03:00
148 lines
4.7 KiB
Elm
148 lines
4.7 KiB
Elm
module Documentation.ReadmeLinksPointToCurrentVersion exposing (rule)
|
|
|
|
{-|
|
|
|
|
@docs rule
|
|
|
|
-}
|
|
|
|
import Elm.Package
|
|
import Elm.Project
|
|
import Elm.Syntax.Range exposing (Range)
|
|
import Elm.Version
|
|
import Regex exposing (Regex)
|
|
import Review.Fix as Fix
|
|
import Review.Rule as Rule exposing (Error, Rule)
|
|
|
|
|
|
{-| Reports links in the `README.md` that point to this project's package documentation on <https://package.elm-lang.org/>,
|
|
where the version is set to `latest` or a different version than the current version of the package.
|
|
|
|
The problem with linking to `latest` is that if you release a new version later,
|
|
the users who read the README for the older version will be directed to a version
|
|
where the module/function/section you pointed to may not exist anymore.
|
|
|
|
This rule ensures that you always use the correct version in all of your releases,
|
|
and that you do not forget to update the links.
|
|
|
|
This rule provides automatic fixes, so you won't to do the tedious job of updating
|
|
the links yourself.
|
|
|
|
**NOTE**: Just make sure to run tests between bumping the version of the package
|
|
and publishing the package. Otherwise the link for a given version could link to a previous one.
|
|
|
|
**NOTE**: A similar rule would be useful for links inside the modules. I'll be working on that too!
|
|
|
|
|
|
## Try it out
|
|
|
|
You can try this rule out by running the following command:
|
|
|
|
```bash
|
|
elm-review --template jfmengels/elm-review-documentation/example --rules NoUselessSubscriptions
|
|
```
|
|
|
|
-}
|
|
rule : Rule
|
|
rule =
|
|
Rule.newProjectRuleSchema "ReadmeLinksPointToCurrentVersion" initialProjectContext
|
|
|> Rule.withElmJsonProjectVisitor elmJsonVisitor
|
|
|> Rule.withReadmeProjectVisitor readmeVisitor
|
|
|> Rule.fromProjectRuleSchema
|
|
|
|
|
|
type alias ProjectContext =
|
|
Maybe
|
|
{ projectName : String
|
|
, version : String
|
|
}
|
|
|
|
|
|
initialProjectContext : ProjectContext
|
|
initialProjectContext =
|
|
Nothing
|
|
|
|
|
|
|
|
-- elm.json VISITOR
|
|
|
|
|
|
elmJsonVisitor : Maybe { a | project : Elm.Project.Project } -> ProjectContext -> ( List nothing, ProjectContext )
|
|
elmJsonVisitor maybeProject _ =
|
|
case maybeProject |> Maybe.map .project of
|
|
Just (Elm.Project.Package pkg) ->
|
|
( []
|
|
, Just
|
|
{ projectName = Elm.Package.toString pkg.name
|
|
, version = Elm.Version.toString pkg.version
|
|
}
|
|
)
|
|
|
|
_ ->
|
|
( [], Nothing )
|
|
|
|
|
|
|
|
-- README VISITOR
|
|
|
|
|
|
readmeVisitor : Maybe { readmeKey : Rule.ReadmeKey, content : String } -> ProjectContext -> ( List (Error scope), ProjectContext )
|
|
readmeVisitor maybeReadme maybeContext =
|
|
case ( maybeReadme, maybeContext ) of
|
|
( Just { readmeKey, content }, Just context ) ->
|
|
( findRangeForSubstring context readmeKey content, maybeContext )
|
|
|
|
_ ->
|
|
( [], maybeContext )
|
|
|
|
|
|
linkRegex : Regex
|
|
linkRegex =
|
|
Regex.fromString "]\\(https://package\\.elm-lang\\.org/packages/([\\w-]+/[\\w-]+)/(\\w+(\\.\\w+\\.\\w+)?)(.*)\\)"
|
|
|> Maybe.withDefault Regex.never
|
|
|
|
|
|
findRangeForSubstring : { projectName : String, version : String } -> Rule.ReadmeKey -> String -> List (Error scope)
|
|
findRangeForSubstring context readmeKey content =
|
|
content
|
|
|> String.lines
|
|
|> List.indexedMap Tuple.pair
|
|
|> List.concatMap
|
|
(\( row, line ) ->
|
|
Regex.find linkRegex line
|
|
|> List.filterMap (notAMatch context readmeKey row)
|
|
)
|
|
|
|
|
|
notAMatch : { projectName : String, version : String } -> Rule.ReadmeKey -> Int -> Regex.Match -> Maybe (Error scope)
|
|
notAMatch { projectName, version } readmeKey row match =
|
|
case match.submatches of
|
|
(Just authorAndPackage) :: (Just linkVersion) :: _ :: rest :: [] ->
|
|
if authorAndPackage == projectName && linkVersion /= version then
|
|
let
|
|
range : Range
|
|
range =
|
|
{ start =
|
|
{ row = row + 1
|
|
, column = match.index + 3
|
|
}
|
|
, end =
|
|
{ row = row + 1
|
|
, column = match.index + String.length match.match
|
|
}
|
|
}
|
|
in
|
|
Rule.errorForReadmeWithFix readmeKey
|
|
{ message = "Link does not point to the current version of the package"
|
|
, details = [ "I suggest to run elm-review --fix to get the correct links." ]
|
|
}
|
|
range
|
|
[ Fix.replaceRangeBy range <| "https://package.elm-lang.org/packages/" ++ projectName ++ "/" ++ version ++ Maybe.withDefault "" rest ]
|
|
|> Just
|
|
|
|
else
|
|
Nothing
|
|
|
|
_ ->
|
|
Nothing
|