fix: dont strip trailing index from links unless it is the full segment

HiDeoo · Dec 19, 2024 · 5d03224 · 5d03224
1 parent 15f877f
commit 5d03224
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/packages/starlight-links-validator/libs/remark.ts b/packages/starlight-links-validator/libs/remark.ts
@@ -178,7 +178,7 @@ function normalizeFilePath(base: string, srcDir: URL, filePath?: string) {
   const path = nodePath
     .relative(nodePath.join(fileURLToPath(srcDir), 'content/docs'), filePath)
     .replace(/\.\w+$/, '')
-    .replace(/index$/, '')
+    .replace(/(^|[/\\])index$/, '$1')
     .replace(/[/\\]?$/, '/')
     .split(/[/\\]/)
     .map((segment) => slug(segment))

diff --git a/...ator/tests/fixtures/valid-links/src/content/docs/a-page-that-ends-with-index.md b/...ator/tests/fixtures/valid-links/src/content/docs/a-page-that-ends-with-index.md
@@ -0,0 +1,5 @@
+---
+title: A page that ends with index
+---
+
+Content
diff --git a/.../starlight-links-validator/tests/fixtures/valid-links/src/content/docs/index.md b/.../starlight-links-validator/tests/fixtures/valid-links/src/content/docs/index.md
@@ -19,6 +19,8 @@ title: Index
 - [An MDX nested page](/guides/example)
 - [An MDX nested page](/guides/example/)
 
+- [A page that ends with index](/a-page-that-ends-with-index)
+
 # More links
 
 - [Link to hash in this page](#some-links)