starlight-links-validator 0.7.0 → 0.8.0

package/index.ts

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

package/libs/validation.ts

@@ -108,6 +108,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('#')
 
@@ -151,8 +155,9 @@ function validateLink(context: ValidationContext) {
   }
 
   if (
-    (astroConfig.trailingSlash === 'always' && !path.endsWith('/')) ||
-    (astroConfig.trailingSlash === 'never' && path.endsWith('/'))
+    path.length > 0 &&
+    ((astroConfig.trailingSlash === 'always' && !path.endsWith('/')) ||
+      (astroConfig.trailingSlash === 'never' && path.endsWith('/')))
   ) {
     addError(errors, filePath, link, ValidationErrorType.TrailingSlash)
     return
@@ -210,6 +215,13 @@ function isValidAsset(path: string, context: ValidationContext) {
   }
 }
 
+/**
+ * Check if a link is explicitly excluded from validation by the user.
+ */
+function isExcludedLink(link: string, context: ValidationContext) {
+  return context.options.exclude.includes(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.0",
+  "version": "0.8.0",
   "license": "MIT",
   "description": "Starlight plugin to validate internal links.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",