mirror of
https://github.com/jfmengels/elm-review.git
synced 2024-08-16 19:40:22 +03:00
265 lines
12 KiB
Elm
265 lines
12 KiB
Elm
module Docs.UpToDateReadmeLinksTest exposing (all)
|
|
|
|
import Docs.UpToDateReadmeLinks exposing (rule)
|
|
import Elm.Project
|
|
import Json.Decode as Decode
|
|
import Review.Project as Project exposing (Project)
|
|
import Review.Test exposing (ReviewResult)
|
|
import Test exposing (Test, describe, test)
|
|
|
|
|
|
testRule : Project -> ReviewResult
|
|
testRule project =
|
|
"""module SomeModule exposing (a)
|
|
a = 1"""
|
|
|> Review.Test.runWithProjectData project rule
|
|
|
|
|
|
createElmJson : String -> { path : String, raw : String, project : Elm.Project.Project }
|
|
createElmJson rawElmJson =
|
|
case Decode.decodeString Elm.Project.decoder rawElmJson of
|
|
Ok elmJson ->
|
|
{ path = "elm.json"
|
|
, raw = rawElmJson
|
|
, project = elmJson
|
|
}
|
|
|
|
Err _ ->
|
|
Debug.todo "Invalid elm.json supplied to test"
|
|
|
|
|
|
packageElmJson : String -> String
|
|
packageElmJson name =
|
|
"""
|
|
{
|
|
"type": "package",
|
|
"name": \""""
|
|
++ name
|
|
++ """",
|
|
"summary": "Summary",
|
|
"license": "BSD-3-Clause",
|
|
"version": "1.2.3",
|
|
"exposed-modules": [
|
|
"Exposed"
|
|
],
|
|
"elm-version": "0.19.0 <= v < 0.20.0",
|
|
"dependencies": {
|
|
"elm/core": "1.0.0 <= v < 2.0.0"
|
|
},
|
|
"test-dependencies": {}
|
|
}"""
|
|
|
|
|
|
message : String
|
|
message =
|
|
"Link does not point to the current version of the package"
|
|
|
|
|
|
details : List String
|
|
details =
|
|
[ "I suggest to run elm-review --fix to get the correct link." ]
|
|
|
|
|
|
readmeWithLink : String -> String
|
|
readmeWithLink link =
|
|
"""
|
|
# My project
|
|
|
|
- [my project's thing](""" ++ link ++ """)
|
|
Don't report:
|
|
- [this](https://package.elm-lang.org/packages/author/other-package/latest/Module-Name)
|
|
- [this](https://package.elm-lang.org/packages/author/other-package/1.2.2/Module-Name)
|
|
- [this](https://package.elm-lang.org/packages/other-author/package/latest/Module-Name)
|
|
- [this](https://package.elm-lang.org/packages/other-author/package/1.2.4/Module-Name)
|
|
"""
|
|
|
|
|
|
all : Test
|
|
all =
|
|
describe "Docs.UpToDateReadmeLinks"
|
|
[ test "should not report an error if there is no elm.json file" <|
|
|
\() ->
|
|
Project.new
|
|
|> addReadme "https://package.elm-lang.org/packages/author/package/1.2.4/Module-Name"
|
|
|> testRule
|
|
|> Review.Test.expectNoErrors
|
|
, test "should not report an error if there is no README file" <|
|
|
\() ->
|
|
Project.new
|
|
|> Project.addElmJson (createElmJson <| packageElmJson "author/package")
|
|
|> testRule
|
|
|> Review.Test.expectNoErrors
|
|
, test "should not report an error if all the links point to the current project use the correct version" <|
|
|
\() ->
|
|
Project.new
|
|
|> Project.addElmJson (createElmJson <| packageElmJson "author/package")
|
|
|> addReadme "https://package.elm-lang.org/packages/author/package/1.2.3/Module-Name"
|
|
|> testRule
|
|
|> Review.Test.expectNoErrors
|
|
, test "should report an error if a link points to a different version" <|
|
|
\() ->
|
|
Project.new
|
|
|> Project.addElmJson (createElmJson <| packageElmJson "author/package")
|
|
|> addReadme "https://package.elm-lang.org/packages/author/package/1.2.4/Module-Name"
|
|
|> testRule
|
|
|> Review.Test.expectErrorsForReadme
|
|
[ Review.Test.error
|
|
{ message = message
|
|
, details = details
|
|
, under = "https://package.elm-lang.org/packages/author/package/1.2.4/Module-Name"
|
|
}
|
|
|> Review.Test.whenFixed (readmeWithLink "https://package.elm-lang.org/packages/author/package/1.2.3/Module-Name/")
|
|
]
|
|
, test "should report errors for multiple links on the same line" <|
|
|
\() ->
|
|
Project.new
|
|
|> Project.addElmJson (createElmJson <| packageElmJson "author/package")
|
|
|> Project.addReadme { path = "README.md", content = """
|
|
[link1](https://package.elm-lang.org/packages/author/package/1.2.4/A) [link2](https://package.elm-lang.org/packages/author/package/1.2.4/B)
|
|
""" }
|
|
|> testRule
|
|
|> Review.Test.expectErrorsForReadme
|
|
[ Review.Test.error
|
|
{ message = message
|
|
, details = details
|
|
, under = "https://package.elm-lang.org/packages/author/package/1.2.4/A"
|
|
}
|
|
|> Review.Test.whenFixed """
|
|
[link1](https://package.elm-lang.org/packages/author/package/1.2.3/A/) [link2](https://package.elm-lang.org/packages/author/package/1.2.4/B)
|
|
"""
|
|
, Review.Test.error
|
|
{ message = message
|
|
, details = details
|
|
, under = "https://package.elm-lang.org/packages/author/package/1.2.4/B"
|
|
}
|
|
|> Review.Test.whenFixed """
|
|
[link1](https://package.elm-lang.org/packages/author/package/1.2.4/A) [link2](https://package.elm-lang.org/packages/author/package/1.2.3/B/)
|
|
"""
|
|
]
|
|
, test "should report an error if a link points to latest" <|
|
|
\() ->
|
|
Project.new
|
|
|> Project.addElmJson (createElmJson <| packageElmJson "author/package")
|
|
|> addReadme "https://package.elm-lang.org/packages/author/package/latest/Module-Name"
|
|
|> testRule
|
|
|> Review.Test.expectErrorsForReadme
|
|
[ Review.Test.error
|
|
{ message = message
|
|
, details = details
|
|
, under = "https://package.elm-lang.org/packages/author/package/latest/Module-Name"
|
|
}
|
|
|> Review.Test.whenFixed (readmeWithLink "https://package.elm-lang.org/packages/author/package/1.2.3/Module-Name/")
|
|
]
|
|
, test "should report an error even if the author or package name contains a dash or digit" <|
|
|
\() ->
|
|
Project.new
|
|
|> Project.addElmJson (createElmJson <| packageElmJson "au-tho5r/pack-age1")
|
|
|> addReadme "https://package.elm-lang.org/packages/au-tho5r/pack-age1/latest/Module-Name"
|
|
|> testRule
|
|
|> Review.Test.expectErrorsForReadme
|
|
[ Review.Test.error
|
|
{ message = message
|
|
, details = details
|
|
, under = "https://package.elm-lang.org/packages/au-tho5r/pack-age1/latest/Module-Name"
|
|
}
|
|
|> Review.Test.whenFixed (readmeWithLink "https://package.elm-lang.org/packages/au-tho5r/pack-age1/1.2.3/Module-Name/")
|
|
]
|
|
, test "should report an error if the link is relative" <|
|
|
\() ->
|
|
Project.new
|
|
|> Project.addElmJson (createElmJson <| packageElmJson "au-tho5r/pack-age1")
|
|
|> addReadme "Some-Module-Name"
|
|
|> testRule
|
|
|> Review.Test.expectErrorsForReadme
|
|
[ Review.Test.error
|
|
{ message = "Found relative link to a module in README"
|
|
, details =
|
|
[ "Relative links to other modules from the README don't work when looking at the docs from GitHub or the likes."
|
|
, "I suggest to run elm-review --fix to change the link to an absolute link."
|
|
]
|
|
, under = "Some-Module-Name"
|
|
}
|
|
|> Review.Test.whenFixed (readmeWithLink "https://package.elm-lang.org/packages/au-tho5r/pack-age1/1.2.3/Some-Module-Name")
|
|
]
|
|
, test "should report an error if the link is relative with a section" <|
|
|
\() ->
|
|
Project.new
|
|
|> Project.addElmJson (createElmJson <| packageElmJson "au-tho5r/pack-age1")
|
|
|> addReadme "Some-Module-Name#section"
|
|
|> testRule
|
|
|> Review.Test.expectErrorsForReadme
|
|
[ Review.Test.error
|
|
{ message = "Found relative link to a module in README"
|
|
, details =
|
|
[ "Relative links to other modules from the README don't work when looking at the docs from GitHub or the likes."
|
|
, "I suggest to run elm-review --fix to change the link to an absolute link."
|
|
]
|
|
, under = "Some-Module-Name#section"
|
|
}
|
|
|> Review.Test.whenFixed (readmeWithLink "https://package.elm-lang.org/packages/au-tho5r/pack-age1/1.2.3/Some-Module-Name#section")
|
|
]
|
|
, test "should not report an error if the link is relative to the README" <|
|
|
\() ->
|
|
Project.new
|
|
|> Project.addElmJson (createElmJson <| packageElmJson "au-tho5r/pack-age1")
|
|
|> addReadme "#section"
|
|
|> testRule
|
|
|> Review.Test.expectNoErrors
|
|
, test "should report an error if the link is relative to the README but starts with ./" <|
|
|
\() ->
|
|
Project.new
|
|
|> Project.addElmJson (createElmJson <| packageElmJson "au-tho5r/pack-age1")
|
|
|> addReadme "./#section"
|
|
|> testRule
|
|
|> Review.Test.expectErrorsForReadme
|
|
[ Review.Test.error
|
|
{ message = "Found relative link from and to README"
|
|
, details =
|
|
[ "Links from and to README that start with \"./\" will not work on all places on GitHub or the likes."
|
|
, "I suggest to remove the leading \"./\"."
|
|
]
|
|
, under = "./#section"
|
|
}
|
|
|> Review.Test.whenFixed (readmeWithLink "#section")
|
|
]
|
|
, test "should report an error but not provide a fix if the link is exactly ./" <|
|
|
\() ->
|
|
Project.new
|
|
|> Project.addElmJson (createElmJson <| packageElmJson "au-tho5r/pack-age1")
|
|
|> addReadme "./"
|
|
|> testRule
|
|
|> Review.Test.expectErrorsForReadme
|
|
[ Review.Test.error
|
|
{ message = "Found relative link from and to README"
|
|
, details =
|
|
[ "Links from and to README that start with \"./\" will not work on all places on GitHub or the likes."
|
|
, "I suggest to remove the leading \"./\"."
|
|
]
|
|
, under = "./"
|
|
}
|
|
]
|
|
, test "should report at the correct location when there are unicode characters in the line" <|
|
|
\() ->
|
|
Project.new
|
|
|> Project.addElmJson (createElmJson <| packageElmJson "au-tho5r/pack-age1")
|
|
|> Project.addReadme { path = "README.md", content = """
|
|
[🔧 `Rule.Name`](https://package.elm-lang.org/packages/au-tho5r/pack-age1/latest/)
|
|
""" }
|
|
|> testRule
|
|
|> Review.Test.expectErrorsForReadme
|
|
[ Review.Test.error
|
|
{ message = "Link does not point to the current version of the package"
|
|
, details = details
|
|
, under = "https://package.elm-lang.org/packages/au-tho5r/pack-age1/latest/"
|
|
}
|
|
|> Review.Test.whenFixed """
|
|
[🔧 `Rule.Name`](https://package.elm-lang.org/packages/au-tho5r/pack-age1/1.2.3/)
|
|
"""
|
|
]
|
|
]
|
|
|
|
|
|
addReadme : String -> Project -> Project
|
|
addReadme contents =
|
|
Project.addReadme { path = "README.md", content = readmeWithLink contents }
|