starlight-links-validator 0.5.0 → 0.5.2

package/index.ts

@@ -48,7 +48,7 @@ export default function starlightLinksValidatorPlugin(
   return {
     name: 'starlight-links-validator-plugin',
     hooks: {
-      setup({ addIntegration, config: starlightConfig, logger }) {
+      setup({ addIntegration, astroConfig, config: starlightConfig, logger }) {
         addIntegration({
           name: 'starlight-links-validator-integration',
           hooks: {
@@ -59,12 +59,12 @@ export default function starlightLinksValidatorPlugin(
 
               updateConfig({
                 markdown: {
-                  remarkPlugins: [remarkStarlightLinksValidator],
+                  remarkPlugins: [[remarkStarlightLinksValidator, astroConfig.base]],
                 },
               })
             },
             'astro:build:done': ({ dir, pages }) => {
-              const errors = validateLinks(pages, dir, starlightConfig, options.data)
+              const errors = validateLinks(pages, dir, astroConfig.base, starlightConfig, options.data)
 
               logErrors(logger, errors)
 
@@ -82,7 +82,7 @@ export default function starlightLinksValidatorPlugin(
 function throwPluginError(message: string): never {
   throw new AstroError(
     message,
-    `See the error report above for more informations.\n\nIf you believe this is a bug, please file an issue at https://github.com/HiDeoo/starlight-links-validator/issues/new/choose.`,
+    `See the error report above for more informations.\n\nIf you believe this is a bug, please file an issue at https://github.com/HiDeoo/starlight-links-validator/issues/new/choose`,
   )
 }
 

package/libs/path.ts

@@ -5,3 +5,7 @@ export function ensureLeadingSlash(path: string): string {
 export function ensureTrailingSlash(path: string): string {
   return path.endsWith('/') ? path : `${path}/`
 }
+
+export function stripLeadingSlash(path: string) {
+  return path.replace(/^\//, '')
+}

package/libs/remark.ts

@@ -12,15 +12,17 @@ import { toString } from 'mdast-util-to-string'
 import type { Plugin } from 'unified'
 import { visit } from 'unist-util-visit'
 
+import { stripLeadingSlash } from './path'
+
 // All the headings keyed by file path.
 const headings: Headings = new Map()
 // All the internal links keyed by file path.
 const links: Links = new Map()
 
-export const remarkStarlightLinksValidator: Plugin<[], Root> = function () {
+export const remarkStarlightLinksValidator: Plugin<[base: string], Root> = function (base) {
   return (tree, file) => {
     const slugger = new GitHubSlugger()
-    const filePath = normalizeFilePath(file.history[0])
+    const filePath = normalizeFilePath(base, file.history[0])
 
     const fileHeadings: string[] = []
     const fileLinks: string[] = []
@@ -134,12 +136,12 @@ function isInternalLink(link: string) {
   return nodePath.isAbsolute(link) || link.startsWith('#') || link.startsWith('.')
 }
 
-function normalizeFilePath(filePath?: string) {
+function normalizeFilePath(base: string, filePath?: string) {
   if (!filePath) {
     throw new Error('Missing file path to validate links.')
   }
 
-  return nodePath
+  const path = nodePath
     .relative(nodePath.join(process.cwd(), 'src/content/docs'), filePath)
     .replace(/\.\w+$/, '')
     .replace(/index$/, '')
@@ -147,6 +149,12 @@ function normalizeFilePath(filePath?: string) {
     .split(/[/\\]/)
     .map((segment) => slug(segment))
     .join('/')
+
+  if (base !== '/') {
+    return nodePath.posix.join(stripLeadingSlash(base), path)
+  }
+
+  return path
 }
 
 function isMdxIdAttribute(attribute: MdxJsxAttribute | MdxJsxExpressionAttribute): attribute is MdxIdAttribute {

package/libs/validation.ts

@@ -1,4 +1,5 @@
 import { statSync } from 'node:fs'
+import { posix } from 'node:path'
 import { fileURLToPath } from 'node:url'
 
 import type { StarlightPlugin } from '@astrojs/starlight/types'
@@ -8,7 +9,7 @@ import { bgGreen, black, blue, dim, green, red } from 'kleur/colors'
 import type { StarlightLinksValidatorOptions } from '..'
 
 import { getFallbackHeadings, getLocaleConfig, isInconsistentLocaleLink, type LocaleConfig } from './i18n'
-import { ensureTrailingSlash } from './path'
+import { ensureTrailingSlash, stripLeadingSlash } from './path'
 import { getValidationData, type Headings } from './remark'
 
 export const ValidationErrorType = {
@@ -21,6 +22,7 @@ export const ValidationErrorType = {
 export function validateLinks(
   pages: PageData[],
   outputDir: URL,
+  base: string,
   starlightConfig: StarlightUserConfig,
   options: StarlightLinksValidatorOptions,
 ): ValidationErrors {
@@ -28,13 +30,18 @@ export function validateLinks(
 
   const localeConfig = getLocaleConfig(starlightConfig)
   const { headings, links } = getValidationData()
-  const allPages: Pages = new Set(pages.map((page) => ensureTrailingSlash(page.pathname)))
+  const allPages: Pages = new Set(
+    pages.map((page) =>
+      ensureTrailingSlash(base === '/' ? page.pathname : posix.join(stripLeadingSlash(base), page.pathname)),
+    ),
+  )
 
   const errors: ValidationErrors = new Map()
 
   for (const [filePath, fileLinks] of links) {
     for (const link of fileLinks) {
       const validationContext: ValidationContext = {
+        base,
         errors,
         filePath,
         headings,
@@ -94,7 +101,7 @@ 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, outputDir, pages } = context
+  const { errors, filePath, link, localeConfig, options, pages } = context
 
   const sanitizedLink = link.replace(/^\//, '')
   const segments = sanitizedLink.split('#')
@@ -114,7 +121,7 @@ function validateLink(context: ValidationContext) {
     return
   }
 
-  if (isValidAsset(path, outputDir)) {
+  if (isValidAsset(path, context)) {
     return
   }
 
@@ -167,8 +174,18 @@ function validateSelfAnchor({ errors, link, filePath, headings }: ValidationCont
 /**
  * Check if a link is a valid asset in the build output directory.
  */
-function isValidAsset(path: string, outputDir: URL) {
-  const filePath = fileURLToPath(new URL(path, outputDir))
+function isValidAsset(path: string, context: ValidationContext) {
+  if (context.base !== '/') {
+    const base = stripLeadingSlash(context.base)
+
+    if (path.startsWith(base)) {
+      path = path.replace(new RegExp(`^${stripLeadingSlash(base)}/?`), '')
+    } else {
+      return false
+    }
+  }
+
+  const filePath = fileURLToPath(new URL(path, context.outputDir))
 
   try {
     const stats = statSync(filePath)
@@ -207,6 +224,7 @@ interface PageData {
 type Pages = Set<PageData['pathname']>
 
 interface ValidationContext {
+  base: string
   errors: ValidationErrors
   filePath: string
   headings: Headings

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-links-validator",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "license": "MIT",
   "description": "Starlight plugin to validate internal links.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",