starlight-links-validator 0.7.1 → 0.9.0

package/index.ts

@@ -33,6 +33,14 @@ const starlightLinksValidatorOptionsSchema = z
      * @default true
      */
     errorOnRelativeLinks: z.boolean().default(true),
+    /**
+     * Defines a list of links or glob patterns that should be excluded from validation.
+     *
+     * The links in this list will be ignored by the plugin and will not be validated.
+     *
+     * @default []
+     */
+    exclude: z.array(z.string()).default([]),
   })
   .default({})
 

package/libs/validation.ts

@@ -5,6 +5,7 @@ import { fileURLToPath } from 'node:url'
 import type { StarlightPlugin } from '@astrojs/starlight/types'
 import type { AstroConfig, AstroIntegrationLogger } from 'astro'
 import { bgGreen, black, blue, dim, green, red } from 'kleur/colors'
+import picomatch from 'picomatch'
 
 import type { StarlightLinksValidatorOptions } from '..'
 
@@ -108,6 +109,10 @@ export function logErrors(pluginLogger: AstroIntegrationLogger, errors: Validati
 function validateLink(context: ValidationContext) {
   const { astroConfig, errors, filePath, link, localeConfig, options, pages } = context
 
+  if (isExcludedLink(link, context)) {
+    return
+  }
+
   const sanitizedLink = link.replace(/^\//, '')
   const segments = sanitizedLink.split('#')
 
@@ -211,6 +216,13 @@ function isValidAsset(path: string, context: ValidationContext) {
   }
 }
 
+/**
+ * Check if a link is excluded from validation by the user.
+ */
+function isExcludedLink(link: string, context: ValidationContext) {
+  return picomatch(context.options.exclude)(link)
+}
+
 function addError(errors: ValidationErrors, filePath: string, link: string, type: ValidationErrorType) {
   const fileErrors = errors.get(filePath) ?? []
   fileErrors.push({ link, type })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-links-validator",
-  "version": "0.7.1",
+  "version": "0.9.0",
   "license": "MIT",
   "description": "Starlight plugin to validate internal links.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -16,6 +16,7 @@
     "is-absolute-url": "4.0.1",
     "kleur": "4.1.5",
     "mdast-util-to-string": "4.0.0",
+    "picomatch": "4.0.2",
     "unist-util-visit": "5.0.0"
   },
   "devDependencies": {
@@ -23,6 +24,7 @@
     "@types/hast": "3.0.3",
     "@types/mdast": "4.0.3",
     "@types/node": "18.17.18",
+    "@types/picomatch": "2.3.3",
     "astro": "4.0.4",
     "mdast-util-mdx-jsx": "3.0.0",
     "typescript": "5.1.3",