starlight-links-validator 0.9.1 → 0.10.1

package/index.ts

@@ -67,7 +67,9 @@ export default function starlightLinksValidatorPlugin(
 
               updateConfig({
                 markdown: {
-                  remarkPlugins: [[remarkStarlightLinksValidator, astroConfig.base]],
+                  remarkPlugins: [
+                    [remarkStarlightLinksValidator, { base: astroConfig.base, srcDir: astroConfig.srcDir }],
+                  ],
                 },
               })
             },

package/libs/remark.ts

@@ -1,6 +1,7 @@
 import 'mdast-util-mdx-jsx'
 
 import nodePath from 'node:path'
+import { fileURLToPath } from 'node:url'
 
 import GitHubSlugger, { slug } from 'github-slugger'
 import type { Nodes } from 'hast'
@@ -20,10 +21,13 @@ const headings: Headings = new Map()
 // All the internal links keyed by file path.
 const links: Links = new Map()
 
-export const remarkStarlightLinksValidator: Plugin<[base: string], Root> = function (base) {
+export const remarkStarlightLinksValidator: Plugin<[{ base: string; srcDir: URL }], Root> = function ({
+  base,
+  srcDir,
+}) {
   return (tree, file) => {
     const slugger = new GitHubSlugger()
-    const filePath = normalizeFilePath(base, file.history[0])
+    const filePath = normalizeFilePath(base, srcDir, file.history[0])
     const slug = file.data.astro?.frontmatter?.slug
 
     const fileHeadings: string[] = []
@@ -39,6 +43,11 @@ export const remarkStarlightLinksValidator: Plugin<[base: string], Root> = funct
       // https://github.com/syntax-tree/mdast-util-mdx-jsx#nodes
       switch (node.type) {
         case 'heading': {
+          if (node.data?.hProperties?.['id']) {
+            fileHeadings.push(String(node.data.hProperties['id']))
+            break
+          }
+
           const content = toString(node)
 
           if (content.length === 0) {
@@ -142,13 +151,13 @@ function getFilePath(filePath: string, slug: string | undefined) {
   return slug ? stripLeadingSlash(ensureTrailingSlash(slug)) : filePath
 }
 
-function normalizeFilePath(base: string, filePath?: string) {
+function normalizeFilePath(base: string, srcDir: URL, filePath?: string) {
   if (!filePath) {
     throw new Error('Missing file path to validate links.')
   }
 
   const path = nodePath
-    .relative(nodePath.join(process.cwd(), 'src/content/docs'), filePath)
+    .relative(nodePath.join(fileURLToPath(srcDir), 'content/docs'), filePath)
     .replace(/\.\w+$/, '')
     .replace(/index$/, '')
     .replace(/[/\\]?$/, '/')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-links-validator",
-  "version": "0.9.1",
+  "version": "0.10.1",
   "license": "MIT",
   "description": "Starlight plugin to validate internal links.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -27,6 +27,7 @@
     "@types/picomatch": "2.3.3",
     "astro": "4.0.4",
     "mdast-util-mdx-jsx": "3.0.0",
+    "remark-custom-heading-id": "2.0.0",
     "typescript": "5.1.3",
     "unified": "11.0.4",
     "vfile": "6.0.1",