starlight-links-validator 0.5.3 → 0.7.0

package/index.ts

@@ -64,7 +64,7 @@ export default function starlightLinksValidatorPlugin(
               })
             },
             'astro:build:done': ({ dir, pages }) => {
-              const errors = validateLinks(pages, dir, astroConfig.base, starlightConfig, options.data)
+              const errors = validateLinks(pages, dir, astroConfig, starlightConfig, options.data)
 
               logErrors(logger, errors)
 

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

@@ -3,7 +3,7 @@ import { posix } from 'node:path'
 import { fileURLToPath } from 'node:url'
 
 import type { StarlightPlugin } from '@astrojs/starlight/types'
-import type { AstroIntegrationLogger } from 'astro'
+import type { AstroConfig, AstroIntegrationLogger } from 'astro'
 import { bgGreen, black, blue, dim, green, red } from 'kleur/colors'
 
 import type { StarlightLinksValidatorOptions } from '..'
@@ -17,12 +17,13 @@ export const ValidationErrorType = {
   InvalidAnchor: 'invalid anchor',
   InvalidLink: 'invalid link',
   RelativeLink: 'relative link',
+  TrailingSlash: 'trailing slash',
 } as const
 
 export function validateLinks(
   pages: PageData[],
   outputDir: URL,
-  base: string,
+  astroConfig: AstroConfig,
   starlightConfig: StarlightUserConfig,
   options: StarlightLinksValidatorOptions,
 ): ValidationErrors {
@@ -32,7 +33,11 @@ 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(
+        astroConfig.base === '/'
+          ? stripLeadingSlash(page.pathname)
+          : posix.join(stripLeadingSlash(astroConfig.base), page.pathname),
+      ),
     ),
   )
 
@@ -41,7 +46,7 @@ export function validateLinks(
   for (const [filePath, fileLinks] of links) {
     for (const link of fileLinks) {
       const validationContext: ValidationContext = {
-        base,
+        astroConfig,
         errors,
         filePath,
         headings,
@@ -101,12 +106,12 @@ export function logErrors(pluginLogger: AstroIntegrationLogger, errors: Validati
  * Validate a link to another internal page that may or may not have a hash.
  */
 function validateLink(context: ValidationContext) {
-  const { errors, filePath, link, localeConfig, options, pages } = context
+  const { astroConfig, errors, filePath, link, localeConfig, options, pages } = context
 
   const sanitizedLink = link.replace(/^\//, '')
   const segments = sanitizedLink.split('#')
 
-  let path = segments[0]
+  const path = segments[0]
   const hash = segments[1]
 
   if (path === undefined) {
@@ -125,10 +130,10 @@ function validateLink(context: ValidationContext) {
     return
   }
 
-  path = ensureTrailingSlash(path)
+  const sanitizedPath = ensureTrailingSlash(path)
 
-  const isValidPage = pages.has(path)
-  const fileHeadings = getFileHeadings(path, context)
+  const isValidPage = pages.has(sanitizedPath)
+  const fileHeadings = getFileHeadings(sanitizedPath, context)
 
   if (!isValidPage || !fileHeadings) {
     addError(errors, filePath, link, ValidationErrorType.InvalidLink)
@@ -142,6 +147,15 @@ function validateLink(context: ValidationContext) {
 
   if (hash && !fileHeadings.includes(hash)) {
     addError(errors, filePath, link, ValidationErrorType.InvalidAnchor)
+    return
+  }
+
+  if (
+    (astroConfig.trailingSlash === 'always' && !path.endsWith('/')) ||
+    (astroConfig.trailingSlash === 'never' && path.endsWith('/'))
+  ) {
+    addError(errors, filePath, link, ValidationErrorType.TrailingSlash)
+    return
   }
 }
 
@@ -175,8 +189,8 @@ function validateSelfAnchor({ errors, link, filePath, headings }: ValidationCont
  * Check if a link is a valid asset in the build output directory.
  */
 function isValidAsset(path: string, context: ValidationContext) {
-  if (context.base !== '/') {
-    const base = stripLeadingSlash(context.base)
+  if (context.astroConfig.base !== '/') {
+    const base = stripLeadingSlash(context.astroConfig.base)
 
     if (path.startsWith(base)) {
       path = path.replace(new RegExp(`^${stripLeadingSlash(base)}/?`), '')
@@ -224,7 +238,7 @@ interface PageData {
 type Pages = Set<PageData['pathname']>
 
 interface ValidationContext {
-  base: string
+  astroConfig: AstroConfig
   errors: ValidationErrors
   filePath: string
   headings: Headings

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-links-validator",
-  "version": "0.5.3",
+  "version": "0.7.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": {