serokell/xrefcheck
1
1
Fork 0
mirror of https://github.com/serokell/xrefcheck.git synced 2024-09-11 13:37:36 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #212 from serokell/Sorokin-Anton/#208-remove-exessive-newlines

Browse Source 
[#208] Remove exessive newlines from output
This commit is contained in:
Sorokin-Anton 2022-11-04 17:41:12 +02:00 committed by GitHub
commit 7dd5c4c3c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 3 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/Xrefcheck/Command.hs
View File

@ -75,7 +75,7 @@ defaultAction Options{..} = do
fmt [int||
=== Repository data ===
#{indentF 2 (build repoInfo)}
#{indentF 2 (build repoInfo)}\
|]
unless (null scanErrs) . reportScanErrs $ sortBy (compare `on` seFile) scanErrs
@ -89,7 +89,7 @@ defaultAction Options{..} = do
Nothing | null scanErrs -> fmtLn "All repository links are valid."
Nothing -> exitFailure
Just (toList -> verifyErrs) -> do
fmt "\n\n"
unless (null scanErrs) $ fmt "\n"
reportVerifyErrs verifyErrs
exitFailure
where

1
src/Xrefcheck/Scan.hs
View File

@ -100,7 +100,6 @@ instance Given ColorMode => Buildable ScanError where
⛀ #{seDescription}
|]
data ScanErrorDescription

4
src/Xrefcheck/Verify.hs
View File

@ -118,7 +118,6 @@ instance (Given ColorMode, Buildable a) => Buildable (WithReferenceLoc a) where
In file #{styleIfNeeded Faint (styleIfNeeded Bold wrlFile)}
bad #{wrlReference}
#{wrlItem}
|]
data VerifyError
@ -160,7 +159,7 @@ instance Given ColorMode => Buildable VerifyError where
| otherwise ->
[int||
⛀ Anchor '#{anchor}' is not present, did you mean:
#{indentF 4 $ blockListF similar}
#{indentF 4 $ blockListF similar}\
|]
AmbiguousAnchorRef file anchor fileAnchors ->
@ -229,7 +228,6 @@ instance Given ColorMode => Buildable VerifyError where
ExternalResourceSomeError err ->
[int||
⛂ #{err}
|]
data RetryAfter = Date UTCTime | Seconds (Time Second)

11
tests/golden/check-anchors/check-anchors.bats
View File

@ -12,8 +12,6 @@ load '../helpers'
@test "We report ambiguous anchor references" {
to_temp xrefcheck -r ambiguous-anchors
assert_diff - <<EOF
=== Invalid references found ===
➥ In file ambiguous-anchors/a.md
@ -32,7 +30,6 @@ assert_diff - <<EOF
Use of ambiguous anchors is discouraged because the target
can change silently while the document containing it evolves.
➥ In file ambiguous-anchors/b.md
bad reference (relative) at src:7:1-48:
- text: "ambiguous anchor in other file"
@ -49,7 +46,6 @@ assert_diff - <<EOF
Use of ambiguous anchors is discouraged because the target
can change silently while the document containing it evolves.
Invalid references dumped, 2 in total.
EOF
}
@ -57,8 +53,6 @@ EOF
@test "We report references to non-existing anchors, giving hints about similar ones" {
to_temp xrefcheck -r non-existing-anchors
assert_diff - <<EOF
=== Invalid references found ===
➥ In file non-existing-anchors/a.md
@ -71,8 +65,6 @@ assert_diff - <<EOF
- h1 (header I) at src:6:1-4
- h2 (header II) at src:8:1-5
➥ In file non-existing-anchors/a.md
bad reference (current file) at src:14:1-18:
- text: "broken"
@ -82,8 +74,6 @@ assert_diff - <<EOF
⛀ Anchor 'heading' is not present, did you mean:
- the-heading (header I) at src:10:1-13
➥ In file non-existing-anchors/a.md
bad reference (current file) at src:16:1-31:
- text: "broken"
@ -92,7 +82,6 @@ assert_diff - <<EOF
⛀ Anchor 'really-unique-anchor' is not present
Invalid references dumped, 3 in total.
EOF
}

1
tests/golden/check-autolinks/check-autolinks.bats
View File

@ -27,7 +27,6 @@ assert_diff - <<EOF
- anchors:
[]
All repository links are valid.
EOF
}

9
tests/golden/check-cli/check-cli.bats
View File

@ -45,8 +45,6 @@ load '../helpers'
to_temp xrefcheck --root .
assert_diff - <<EOF
=== Invalid references found ===
➥ In file to-ignore/broken-link.md
@ -58,7 +56,6 @@ load '../helpers'
⛀ File does not exist:
./one/two/three
Invalid references dumped, 1 in total.
EOF
}
@ -67,8 +64,6 @@ EOF
to_temp xrefcheck --root ././///././././//./
assert_diff - <<EOF
=== Invalid references found ===
➥ In file to-ignore/broken-link.md
@ -80,7 +75,6 @@ EOF
⛀ File does not exist:
./one/two/three
Invalid references dumped, 1 in total.
EOF
}
@ -89,8 +83,6 @@ EOF
to_temp xrefcheck
assert_diff - <<EOF
=== Invalid references found ===
➥ In file to-ignore/broken-link.md
@ -102,7 +94,6 @@ EOF
⛀ File does not exist:
./one/two/three
Invalid references dumped, 1 in total.
EOF
}

3
tests/golden/check-footnotes/expected.gold
View File

@ -1,5 +1,3 @@
=== Invalid references found ===
➥ In file broken-link-in-footnote/file-with-footnote-with-broken-link.md
@ -11,5 +9,4 @@
⛀ File does not exist:
broken-link-in-footnote/notExists
Invalid references dumped, 1 in total.

3
tests/golden/check-git/check-git.bats
View File

@ -41,8 +41,6 @@ load '../helpers'
to_temp xrefcheck
assert_diff - <<EOF
=== Invalid references found ===
➥ In file git.md
@ -54,7 +52,6 @@ load '../helpers'
⛀ File does not exist:
a.md
Invalid references dumped, 1 in total.
EOF
}

4
tests/golden/check-ignore/check-ignore.bats
View File

@ -45,7 +45,6 @@ load '../helpers'
⛀ Annotation "ignore all" must be at the top of markdown or right after comments at the top
Scan errors dumped, 1 in total.
EOF
}
@ -61,10 +60,8 @@ EOF
⛀ Annotation "ignore all" must be at the top of markdown or right after comments at the top
Scan errors dumped, 1 in total.
=== Invalid references found ===
➥ In file check-ignore.md
@ -76,7 +73,6 @@ Scan errors dumped, 1 in total.
⛀ File does not exist:
./referenced-file.md
Invalid references dumped, 1 in total.
EOF
}

3
tests/golden/check-ignore/expected.gold
View File

@ -1,5 +1,3 @@
=== Scan errors found ===
➥ In file ./to-ignore/inner-directory/broken_annotation.md
@ -7,5 +5,4 @@
⛀ Annotation "ignore all" must be at the top of markdown or right after comments at the top
Scan errors dumped, 1 in total.

10
tests/golden/check-ignoreExternalRefsTo/expected.gold
View File

@ -1,5 +1,3 @@
=== Invalid references found ===
➥ In file check-ignoreExternalRefsTo.md
@ -10,8 +8,6 @@
⛂ InternalException (HostCannotConnect "localhost" [Network.Socket.connect: <socket: N>: does not exist (Connection refused)])
➥ In file check-ignoreExternalRefsTo.md
bad reference (external) at src:9:10-45:
- text: "team"
@ -20,8 +16,6 @@
⛂ InternalException (HostCannotConnect "127.0.0.1" [Network.Socket.connect: <socket: N>: does not exist (Connection refused)])
➥ In file check-ignoreExternalRefsTo.md
bad reference (external) at src:11:10-44:
- text: "blog"
@ -30,8 +24,6 @@
⛂ ConnectionFailure Network.Socket.connect: <socket: N>: does not exist (Connection refused)
➥ In file check-ignoreExternalRefsTo.md
bad reference (external) at src:13:10-44:
- text: "labs"
@ -40,6 +32,4 @@
⛂ ConnectionFailure Network.Socket.connect: <socket: N>: does not exist (Connection refused)
Invalid references dumped, 4 in total.

9
tests/golden/check-ignoreLocalRefsTo/expected.gold
View File

@ -1,5 +1,3 @@
=== Invalid references found ===
➥ In file check-ignoreLocalRefsTo.md
@ -11,7 +9,6 @@
⛀ File does not exist:
./one/a.md
➥ In file check-ignoreLocalRefsTo.md
bad reference (absolute) at src:9:1-26:
- text: "glob wildcard"
@ -21,7 +18,6 @@
⛀ File does not exist:
./two/b.md
➥ In file check-ignoreLocalRefsTo.md
bad reference (absolute) at src:11:1-39:
- text: "recursive directory glob"
@ -31,7 +27,6 @@
⛀ File does not exist:
./three/c.md
➥ In file check-ignoreLocalRefsTo.md
bad reference (absolute) at src:13:1-51:
- text: "recursive nested directory glob"
@ -41,7 +36,6 @@
⛀ File does not exist:
./three/four/d.md
➥ In file check-ignoreLocalRefsTo.md
bad reference (absolute) at src:15:1-59:
- text: "another recursive nested directory glob"
@ -51,7 +45,6 @@
⛀ File does not exist:
./three/five/e.md
➥ In file one/file.md
bad reference (relative) at src:7:1-58:
- text: "check ignoreLocalRefsTo are relative to the root"
@ -61,7 +54,6 @@
⛀ File does not exist:
one/a.md
➥ In file one/file.md
bad reference (relative) at src:9:1-23:
- text: "one more"
@ -71,5 +63,4 @@
⛀ File does not exist:
one/../two/b.md
Invalid references dumped, 7 in total.

3
tests/golden/check-ignoreRefsFrom/check-ignoreRefsFrom.bats
View File

@ -32,8 +32,6 @@ load '../helpers'
to_temp xrefcheck -c config-directory.yaml
assert_diff - <<EOF
=== Invalid references found ===
➥ In file ignoreRefsFrom/inner-directory/bad-reference.md
@ -45,7 +43,6 @@ load '../helpers'
⛀ File does not exist:
./no-file.md
Invalid references dumped, 1 in total.
EOF
}

7
tests/golden/check-images/expected.gold
View File

@ -29,9 +29,6 @@
- anchors:
[]
=== Invalid references found ===
➥ In file check-images.md
@ -42,7 +39,6 @@
⛂ Resource unavailable (404 Not Found)
➥ In file check-images.md
bad reference (external) at src:16:1-33:
- text: "bad image ref 2"
@ -51,7 +47,6 @@
⛂ Resource unavailable (404 Not Found)
➥ In file check-images.md
bad reference (relative) at src:20:1-34:
- text: "bad image ref 3"
@ -61,7 +56,6 @@
⛀ File does not exist:
3.png
➥ In file check-images.md
bad reference (relative) at src:21:1-33:
- text: "bad image ref 4"
@ -71,5 +65,4 @@
⛀ File does not exist:
4.png
Invalid references dumped, 4 in total.

15
tests/golden/check-local-refs/expected1.gold
View File

@ -1,5 +1,3 @@
=== Invalid references found ===
➥ In file dir1/dir2/d2f1.md
@ -10,7 +8,6 @@
⛀ Anchor 'bad' is not present
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:27:1-43:
- text: "bad-file-rel"
@ -20,7 +17,6 @@
⛀ File does not exist:
dir1/dir2/../a/b/c/unexisting-file.md
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:28:1-31:
- text: "bad-casing-file-rel"
@ -30,7 +26,6 @@
⛀ File does not exist:
dir1/dir2/D2F2.md/
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:29:1-32:
- text: "bad-casing-folder-rel"
@ -40,7 +35,6 @@
⛀ File does not exist:
dir1/dir2/../DIR2
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:31:1-38:
- text: "bad-anchor-rel-1"
@ -49,7 +43,6 @@
⛀ Anchor 'bad-anchor' is not present
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:32:1-49:
- text: "bad-anchor-rel-2"
@ -59,7 +52,6 @@
⛀ File does not exist:
dir1/dir2/unexisting-file.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:42:1-22:
- text: "file-abs-2"
@ -69,7 +61,6 @@
⛀ File does not exist:
./d1f1.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:43:1-27:
- text: "file-abs-3"
@ -79,7 +70,6 @@
⛀ File does not exist:
./dir2/d2f2.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:44:1-32:
- text: "file-abs-4"
@ -89,7 +79,6 @@
⛀ File does not exist:
././dir2/../d1f1.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:45:1-37:
- text: "file-abs-slash"
@ -99,7 +88,6 @@
⛀ File does not exist:
././dir2/../d1f1.md/
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:46:1-55:
- text: "anchor-abs-3"
@ -109,7 +97,6 @@
⛀ File does not exist:
././dir2/../d1f1.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:57:1-16:
- text: "A"
@ -119,7 +106,6 @@
⛀ Link targets a local file outside repository:
./../../a.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:58:1-18:
- text: "B"
@ -129,5 +115,4 @@
⛀ Link targets a local file outside repository:
./b/../../b.md
Invalid references dumped, 13 in total.

18
tests/golden/check-local-refs/expected2.gold
View File

@ -1,5 +1,3 @@
=== Invalid references found ===
➥ In file dir1/dir2/d2f1.md
@ -10,7 +8,6 @@
⛀ Anchor 'bad' is not present
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:27:1-43:
- text: "bad-file-rel"
@ -20,7 +17,6 @@
⛀ File does not exist:
dir1/dir2/../a/b/c/unexisting-file.md
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:28:1-31:
- text: "bad-casing-file-rel"
@ -30,7 +26,6 @@
⛀ File does not exist:
dir1/dir2/D2F2.md/
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:29:1-32:
- text: "bad-casing-folder-rel"
@ -40,7 +35,6 @@
⛀ File does not exist:
dir1/dir2/../DIR2
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:31:1-38:
- text: "bad-anchor-rel-1"
@ -49,7 +43,6 @@
⛀ Anchor 'bad-anchor' is not present
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:32:1-49:
- text: "bad-anchor-rel-2"
@ -59,7 +52,6 @@
⛀ File does not exist:
dir1/dir2/unexisting-file.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:36:1-29:
- text: "file-abs-1"
@ -69,7 +61,6 @@
⛀ File does not exist:
dir1/dir1/./d1f1.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:37:1-21:
- text: "folder-abs-1"
@ -79,7 +70,6 @@
⛀ File does not exist:
dir1/dir1
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:38:1-30:
- text: "folder-abs-2"
@ -89,7 +79,6 @@
⛀ File does not exist:
dir1/dir1/dir2/../
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:39:1-58:
- text: "anchor-abs-1"
@ -99,7 +88,6 @@
⛀ File does not exist:
dir1/dir1/../dir1/d1f1.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:40:1-73:
- text: "anchor-abs-2"
@ -109,7 +97,6 @@
⛀ File does not exist:
dir1/dir1/dir2/../../dir1/./dir2/d2f2.md
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:51:1-42:
- text: "path-through-top-dir"
@ -119,7 +106,6 @@
⛀ Link targets a local file outside repository:
dir1/dir2/../../dir1/d1f1.md
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:52:1-75:
- text: "path-through-top-dir-with-anchor"
@ -129,7 +115,6 @@
⛀ Link targets a local file outside repository:
dir1/dir2/../../dir1/d1f1.md
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:53:1-26:
- text: "ref-to-d0"
@ -139,7 +124,6 @@
⛀ Link targets a local file outside repository:
dir1/dir2/../../d0f1.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:57:1-16:
- text: "A"
@ -149,7 +133,6 @@
⛀ Link targets a local file outside repository:
dir1/../../a.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:58:1-18:
- text: "B"
@ -159,5 +142,4 @@
⛀ Link targets a local file outside repository:
dir1/b/../../b.md
Invalid references dumped, 16 in total.

14
tests/golden/check-local-refs/expected3.gold
View File

@ -1,5 +1,3 @@
=== Invalid references found ===
➥ In file dir1/dir2/d2f1.md
@ -10,7 +8,6 @@
⛀ Anchor 'bad' is not present
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:27:1-43:
- text: "bad-file-rel"
@ -20,7 +17,6 @@
⛀ File does not exist:
dir1/dir2/../a/b/c/unexisting-file.md
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:28:1-31:
- text: "bad-casing-file-rel"
@ -30,7 +26,6 @@
⛀ File does not exist:
dir1/dir2/D2F2.md/
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:31:1-38:
- text: "bad-anchor-rel-1"
@ -39,7 +34,6 @@
⛀ Anchor 'bad-anchor' is not present
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:32:1-49:
- text: "bad-anchor-rel-2"
@ -49,7 +43,6 @@
⛀ File does not exist:
dir1/dir2/unexisting-file.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:36:1-29:
- text: "file-abs-1"
@ -59,7 +52,6 @@
⛀ File does not exist:
dir1/dir1/./d1f1.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:37:1-21:
- text: "folder-abs-1"
@ -69,7 +61,6 @@
⛀ File does not exist:
dir1/dir1
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:38:1-30:
- text: "folder-abs-2"
@ -79,7 +70,6 @@
⛀ File does not exist:
dir1/dir1/dir2/../
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:39:1-58:
- text: "anchor-abs-1"
@ -89,7 +79,6 @@
⛀ File does not exist:
dir1/dir1/../dir1/d1f1.md
➥ In file dir1/dir2/d2f1.md
bad reference (absolute) at src:40:1-73:
- text: "anchor-abs-2"
@ -99,7 +88,6 @@
⛀ File does not exist:
dir1/dir1/dir2/../../dir1/./dir2/d2f2.md
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:51:1-42:
- text: "path-through-top-dir"
@ -109,7 +97,6 @@
⛀ Link targets a local file outside repository:
dir1/dir2/../../dir1/d1f1.md
➥ In file dir1/dir2/d2f1.md
bad reference (relative) at src:52:1-75:
- text: "path-through-top-dir-with-anchor"
@ -119,5 +106,4 @@
⛀ Link targets a local file outside repository:
dir1/dir2/../../dir1/d1f1.md
Invalid references dumped, 12 in total.

11
tests/golden/check-scan-errors/expected.gold
View File

@ -5,46 +5,38 @@
⛀ Annotation "ignore all" must be at the top of markdown or right after comments at the top
➥ In file check-scan-errors.md
scan error at src:13:1-36:
⛀ Expected a PARAGRAPH after "ignore paragraph" annotation, but found HEADING
➥ In file check-scan-errors.md
scan error at src:17:1-31:
⛀ Expected a LINK after "ignore link" annotation
➥ In file check-scan-errors.md
scan error at src:21:1-50:
⛀ Unrecognised option "unrecognised-annotation" perhaps you meant <"ignore link"|"ignore paragraph"|"ignore all">
➥ In file check-second-file.md
scan error at src:9:1-29:
⛀ Annotation "ignore all" must be at the top of markdown or right after comments at the top
➥ In file no_link_eof.md
scan error at src:9:1-31:
⛀ Expected a LINK after "ignore link" annotation
➥ In file no_paragraph_eof.md
scan error at src:9:1-36:
⛀ Expected a PARAGRAPH after "ignore paragraph" annotation, but found EOF
Scan errors dumped, 7 in total.
=== Invalid references found ===
➥ In file check-scan-errors.md
@ -56,7 +48,6 @@ Scan errors dumped, 7 in total.
⛀ File does not exist:
./no-file.md
➥ In file check-scan-errors.md
bad reference (relative) at src:23:1-24:
- text: "Bad link"
@ -66,7 +57,6 @@ Scan errors dumped, 7 in total.
⛀ File does not exist:
bad.link.com
➥ In file check-second-file.md
bad reference (absolute) at src:11:1-30:
- text: "Another bad reference"
@ -76,5 +66,4 @@ Scan errors dumped, 7 in total.
⛀ File does not exist:
./a.md
Invalid references dumped, 3 in total.