fix: should only check valid fragments in markdown (.md) files

theoludwig · Jan 30, 2024 · e20ee54 · e20ee54
1 parent 5c39afb
commit e20ee54
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 0 deletions.
diff --git a/src/index.js b/src/index.js
@@ -97,6 +97,10 @@ const customRule = {
           continue
         }
 
+        if (!url.pathname.endsWith(".md")) {
+          continue
+        }
+
         const fileContent = fs.readFileSync(url, { encoding: "utf8" })
         const headings = getMarkdownHeadings(fileContent)
         const idOrAnchorNameHTMLFragments =

diff --git a/test/fixtures/valid/only-parse-markdown-files-for-fragments/abc.txt b/test/fixtures/valid/only-parse-markdown-files-for-fragments/abc.txt
diff --git a/test/fixtures/valid/only-parse-markdown-files-for-fragments/awesome.html b/test/fixtures/valid/only-parse-markdown-files-for-fragments/awesome.html
@@ -0,0 +1,9 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Awesome</title>
+  </head>
+  <body></body>
+</html>
diff --git a/...y-parse-markdown-files-for-fragments/only-parse-markdown-files-for-fragments.md b/...y-parse-markdown-files-for-fragments/only-parse-markdown-files-for-fragments.md
@@ -0,0 +1,7 @@
+# Valid
+
+[Link fragment HTML](./awesome.html#existing-heading)
+
+[Link fragment TXT](./abc.txt#existing-heading)
+
+[Link fragment Image](../../image.png#existing-heading)
diff --git a/test/index.test.js b/test/index.test.js
@@ -123,6 +123,11 @@ test("ensure the rule validates correctly", async (t) => {
         fixturePath:
           "test/fixtures/valid/existing-heading-fragment/existing-heading-fragment.md",
       },
+      {
+        name: "should only parse markdown files for fragments checking",
+        fixturePath:
+          "test/fixtures/valid/only-parse-markdown-files-for-fragments/only-parse-markdown-files-for-fragments.md",
+      },
       {
         name: "with an existing file",
         fixturePath: "test/fixtures/valid/existing-file.md",