starlight-links-validator 0.5.3 → 0.6.0

package/libs/remark.ts

@@ -13,7 +13,7 @@ import { toString } from 'mdast-util-to-string'
 import type { Plugin } from 'unified'
 import { visit } from 'unist-util-visit'
 
-import { stripLeadingSlash } from './path'
+import { ensureTrailingSlash, stripLeadingSlash } from './path'
 
 // All the headings keyed by file path.
 const headings: Headings = new Map()
@@ -24,6 +24,7 @@ export const remarkStarlightLinksValidator: Plugin<[base: string], Root> = funct
   return (tree, file) => {
     const slugger = new GitHubSlugger()
     const filePath = normalizeFilePath(base, file.history[0])
+    const slug = file.data.astro?.frontmatter?.slug
 
     const fileHeadings: string[] = []
     const fileLinks: string[] = []
@@ -124,8 +125,8 @@ export const remarkStarlightLinksValidator: Plugin<[base: string], Root> = funct
       }
     })
 
-    headings.set(filePath, fileHeadings)
-    links.set(filePath, fileLinks)
+    headings.set(getFilePath(filePath, slug), fileHeadings)
+    links.set(getFilePath(filePath, slug), fileLinks)
   }
 }
 
@@ -137,6 +138,10 @@ function isInternalLink(link: string) {
   return !isAbsoluteUrl(link)
 }
 
+function getFilePath(filePath: string, slug: string | undefined) {
+  return slug ? stripLeadingSlash(ensureTrailingSlash(slug)) : filePath
+}
+
 function normalizeFilePath(base: string, filePath?: string) {
   if (!filePath) {
     throw new Error('Missing file path to validate links.')
@@ -170,3 +175,13 @@ interface MdxIdAttribute {
   type: 'mdxJsxAttribute'
   value: string
 }
+
+declare module 'vfile' {
+  interface DataMap {
+    astro?: {
+      frontmatter?: {
+        slug?: string
+      }
+    }
+  }
+}

package/libs/validation.ts

@@ -32,7 +32,9 @@ export function validateLinks(
   const { headings, links } = getValidationData()
   const allPages: Pages = new Set(
     pages.map((page) =>
-      ensureTrailingSlash(base === '/' ? page.pathname : posix.join(stripLeadingSlash(base), page.pathname)),
+      ensureTrailingSlash(
+        base === '/' ? stripLeadingSlash(page.pathname) : posix.join(stripLeadingSlash(base), page.pathname),
+      ),
     ),
   )
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-links-validator",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "license": "MIT",
   "description": "Starlight plugin to validate internal links.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -27,6 +27,7 @@
     "mdast-util-mdx-jsx": "3.0.0",
     "typescript": "5.1.3",
     "unified": "11.0.4",
+    "vfile": "6.0.1",
     "vitest": "1.0.4"
   },
   "peerDependencies": {