starlight-links-validator 0.5.1 → 0.5.3

package/index.ts

@@ -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/remark.ts

@@ -6,6 +6,7 @@ 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'
@@ -133,7 +134,7 @@ export function getValidationData() {
 }
 
 function isInternalLink(link: string) {
-  return nodePath.isAbsolute(link) || link.startsWith('#') || link.startsWith('.')
+  return !isAbsoluteUrl(link)
 }
 
 function normalizeFilePath(base: string, filePath?: string) {

package/libs/validation.ts

@@ -41,6 +41,7 @@ export function validateLinks(
   for (const [filePath, fileLinks] of links) {
     for (const link of fileLinks) {
       const validationContext: ValidationContext = {
+        base,
         errors,
         filePath,
         headings,
@@ -100,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('#')
@@ -112,7 +113,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)
     }
@@ -120,7 +121,7 @@ function validateLink(context: ValidationContext) {
     return
   }
 
-  if (isValidAsset(path, outputDir)) {
+  if (isValidAsset(path, context)) {
     return
   }
 
@@ -173,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)
@@ -213,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.1",
+  "version": "0.5.3",
   "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"