fix: prevent invalid validation issues in files with a path containin…

…g special characters
HiDeoo · Aug 16, 2023 · 4b6f66d · 4b6f66d
1 parent 3342331
commit 4b6f66d
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 2 deletions.
diff --git a/packages/starlight-links-validator/libs/remark.ts b/packages/starlight-links-validator/libs/remark.ts
@@ -130,6 +130,9 @@ function normalizeFilePath(filePath?: string) {
     .replace(/\.\w+$/, '')
     .replace(/index$/, '')
     .replace(/\/?$/, '/')
+    .split('/')
+    .map((segment) => slug(segment))
+    .join('/')
 }
 
 function isMdxIdAttribute(attribute: MdxJsxAttribute | MdxJsxExpressionAttribute): attribute is MdxIdAttribute {

diff --git a/...tor/tests/fixtures/with-invalid-links/src/content/docs/guides/Namespace.Test.md b/...tor/tests/fixtures/with-invalid-links/src/content/docs/guides/Namespace.Test.md
@@ -0,0 +1,8 @@
+---
+title: Namespace Test
+---
+
+## Some content
+
+[A link](#some-other-content)
+[Another link](/guides/namespacetest/#another-content)
diff --git a/...dator/tests/fixtures/with-valid-links/src/content/docs/guides/Namespace.Test.md b/...dator/tests/fixtures/with-valid-links/src/content/docs/guides/Namespace.Test.md
@@ -0,0 +1,8 @@
+---
+title: Namespace Test
+---
+
+## Some content
+
+[A link](#some-content)
+[Another link](/guides/namespacetest/#some-content)
diff --git a/packages/starlight-links-validator/tests/validation.test.ts b/packages/starlight-links-validator/tests/validation.test.ts
@@ -11,12 +11,12 @@ test('should build with valid links', async () => {
 })
 
 test('should not build with invalid links', async () => {
-  expect.assertions(3)
+  expect.assertions(4)
 
   try {
     await loadFixture('with-invalid-links')
   } catch (error) {
-    expect(error).toMatch(/Found 12 invalid links in 2 files./)
+    expect(error).toMatch(/Found 14 invalid links in 3 files./)
 
     expect(error).toMatch(
       new RegExp(`▶ test/
@@ -37,5 +37,11 @@ test('should not build with invalid links', async () => {
   ├─ /unknown
   └─ #anotherBlock`)
     )
+
+    expect(error).toMatch(
+      new RegExp(`▶ guides/namespacetest/
+  ├─ #some-other-content
+  └─ /guides/namespacetest/#another-content`)
+    )
   }
 })