fix: do not fail on empty # and #top fragments

The empty "#" and "#top" fragments are always valid without related HTML element. Browser will scroll to the top of the page. Hence lychee must not fail on those. Credits go to @thiru-appitap for initial attempt and helping to find missing parts of the implementation. Solves: #1599 Signed-off-by: MichaIng <[email protected]>
lycheeverse · Jan 13, 2025 · 17bf32c · 17bf32c
1 parent a11d515
commit 17bf32c
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 4 deletions.
diff --git a/fixtures/fragments/file.html b/fixtures/fragments/file.html
@@ -22,6 +22,8 @@
       <a href="#Upper-ÄÖö">back to Upper-ÄÖö</a><br>
       <a href="#Upper-%C3%84%C3%96%C3%B6">back to öüä encoded</a><br>
       <a href="#in-the-end">doesn't exist</a><br>
+      <a href="#">To the top</a><br>
+      <a href="#top">To the top alt</a><br>
     </section>
   </body>
 </html>
diff --git a/fixtures/fragments/file1.md b/fixtures/fragments/file1.md
@@ -54,4 +54,12 @@ Therefore we put the test into a code block for now to prevent false positives.
 [Link to umlauts wrong case](#fünf-sÜße-Äpfel)
 [Link to umlauts with percent encoding](#f%C3%BCnf-s%C3%BC%C3%9Fe-%C3%A4pfel)
 
+# To top fragments
+
+The empty "#" and "#top" fragments are always valid
+without related HTML element. Browser will scroll to the top of the page.
+
+[Link to top of file2](file2.md#)
+[Alternative link to top of file2](file2.md#top)
+
 ##### Lets wear a hat: être
diff --git a/lychee-bin/tests/cli.rs b/lychee-bin/tests/cli.rs
@@ -1834,8 +1834,10 @@ mod cli {
             .stderr(contains(
                 "fixtures/fragments/file1.md#kebab-case-fragment-1",
             ))
-            .stdout(contains("21 Total"))
-            .stdout(contains("17 OK"))
+            .stderr(contains("fixtures/fragments/file.html#top"))
+            .stderr(contains("fixtures/fragments/file2.md#top"))
+            .stdout(contains("25 Total"))
+            .stdout(contains("21 OK"))
             // 4 failures because of missing fragments
             .stdout(contains("4 Errors"));
     }

diff --git a/lychee-lib/src/utils/fragment_checker.rs b/lychee-lib/src/utils/fragment_checker.rs
@@ -39,14 +39,18 @@ impl FragmentChecker {
 
     /// Checks if the given path contains the given fragment.
     ///
-    /// Returns false, if there is a fragment in the link and the path is to a
-    /// Markdown file, which doesn't contain the given fragment.
+    /// Returns false, if there is a fragment in the link which is not empty or "top"
+    /// and the path is to a Markdown file, which doesn't contain the given fragment.
+    /// (Empty # and #top fragments are always valid, triggering the browser to scroll to top.)
     ///
     /// In all other cases, returns true.
     pub(crate) async fn check(&self, path: &Path, url: &Url) -> Result<bool> {
         let Some(fragment) = url.fragment() else {
             return Ok(true);
         };
+        if fragment.is_empty() || fragment.eq_ignore_ascii_case("top") {
+            return Ok(true);
+        };
         let mut fragment_decoded = percent_decode_str(fragment).decode_utf8()?;
         let url_without_frag = Self::remove_fragment(url.clone());