[#208] Remove exessive newlines from output

Problem: xrefcheck's output contains many redundant newlines, so it takes more display space than it could. For list of places where such newlines appear, see #208 Solution: don't print redundant newlines, so output is more compact. Since tests are newline-sensetive, I've checked that now there are no extra (e.g. 2 ajacent) blank lines in `expected` part of tests.
serokell · Nov 4, 2022 · 1476bd3 · 1476bd3
1 parent b498650
commit 1476bd3
Show file tree

Hide file tree

Showing 18 changed files with 3 additions and 127 deletions.
diff --git a/src/Xrefcheck/Command.hs b/src/Xrefcheck/Command.hs
@@ -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

diff --git a/src/Xrefcheck/Scan.hs b/src/Xrefcheck/Scan.hs
@@ -100,7 +100,6 @@ instance Given ColorMode => Buildable ScanError where
 
     ⛀  #{seDescription}
 
-
     |]
 
 data ScanErrorDescription

diff --git a/src/Xrefcheck/Verify.hs b/src/Xrefcheck/Verify.hs
@@ -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)

diff --git a/tests/golden/check-anchors/check-anchors.bats b/tests/golden/check-anchors/check-anchors.bats
@@ -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,16 +46,13 @@ 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
 }
 
 @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
 }
diff --git a/tests/golden/check-autolinks/check-autolinks.bats b/tests/golden/check-autolinks/check-autolinks.bats
@@ -27,7 +27,6 @@ assert_diff - <<EOF
     - anchors:
         []
 
-
 All repository links are valid.
 EOF
 }
diff --git a/tests/golden/check-cli/check-cli.bats b/tests/golden/check-cli/check-cli.bats
@@ -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
 }

diff --git a/tests/golden/check-footnotes/expected.gold b/tests/golden/check-footnotes/expected.gold
@@ -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.
diff --git a/tests/golden/check-git/check-git.bats b/tests/golden/check-git/check-git.bats
@@ -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
 }
diff --git a/tests/golden/check-ignore/check-ignore.bats b/tests/golden/check-ignore/check-ignore.bats
@@ -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
 }

diff --git a/tests/golden/check-ignore/expected.gold b/tests/golden/check-ignore/expected.gold
@@ -1,11 +1,8 @@
-
-
 === Scan errors found ===
 
   ➥  In file ./to-ignore/inner-directory/broken_annotation.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
 
-
 Scan errors dumped, 1 in total.
diff --git a/tests/golden/check-ignoreExternalRefsTo/expected.gold b/tests/golden/check-ignoreExternalRefsTo/expected.gold
@@ -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.
diff --git a/tests/golden/check-ignoreLocalRefsTo/expected.gold b/tests/golden/check-ignoreLocalRefsTo/expected.gold
@@ -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.
diff --git a/tests/golden/check-ignoreRefsFrom/check-ignoreRefsFrom.bats b/tests/golden/check-ignoreRefsFrom/check-ignoreRefsFrom.bats
@@ -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
 }
diff --git a/tests/golden/check-images/expected.gold b/tests/golden/check-images/expected.gold
@@ -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.