starlight-links-validator 0.5.2 → 0.6.0

package/libs/remark.ts

@@ -6,13 +6,14 @@ import GitHubSlugger, { slug } from 'github-slugger'
 import type { Nodes } from 'hast'
 import { fromHtml } from 'hast-util-from-html'
 import { hasProperty } from 'hast-util-has-property'
+import isAbsoluteUrl from 'is-absolute-url'
 import type { Root } from 'mdast'
 import type { MdxJsxAttribute, MdxJsxExpressionAttribute } from 'mdast-util-mdx-jsx'
 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()
@@ -23,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[] = []
@@ -123,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)
   }
 }
 
@@ -133,7 +135,11 @@ export function getValidationData() {
 }
 
 function isInternalLink(link: string) {
-  return nodePath.isAbsolute(link) || link.startsWith('#') || link.startsWith('.')
+  return !isAbsoluteUrl(link)
+}
+
+function getFilePath(filePath: string, slug: string | undefined) {
+  return slug ? stripLeadingSlash(ensureTrailingSlash(slug)) : filePath
 }
 
 function normalizeFilePath(base: string, filePath?: string) {
@@ -169,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),
+      ),
     ),
   )
 
@@ -113,7 +115,7 @@ function validateLink(context: ValidationContext) {
     throw new Error('Failed to validate a link with no path.')
   }
 
-  if (path.startsWith('.')) {
+  if (path.startsWith('.') || !link.startsWith('/')) {
     if (options.errorOnRelativeLinks) {
       addError(errors, filePath, link, ValidationErrorType.RelativeLink)
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-links-validator",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "license": "MIT",
   "description": "Starlight plugin to validate internal links.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -13,6 +13,7 @@
     "github-slugger": "2.0.0",
     "hast-util-from-html": "2.0.1",
     "hast-util-has-property": "3.0.0",
+    "is-absolute-url": "4.0.1",
     "kleur": "4.1.5",
     "mdast-util-to-string": "4.0.0",
     "unist-util-visit": "5.0.0"
@@ -26,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": {