starlight-links-validator 0.10.1 → 0.12.0

package/README.md

@@ -27,8 +27,8 @@ Want to get started immediately? Check out the [getting started guide](https://s
 A [Starlight](https://starlight.astro.build) plugin to validate **_internal_** links in Markdown and MDX files.
 
 - Validate internal links to other pages
-- Validate internal links to anchors in other pages
-- Validate internal links to anchors in the same page
+- Validate internal links to hashes in other pages
+- Validate internal links to hashes in the same page
 - Ignore external links
 - Run only during a production build
 

package/index.ts

@@ -33,6 +33,14 @@ const starlightLinksValidatorOptionsSchema = z
      * @default true
      */
     errorOnRelativeLinks: z.boolean().default(true),
+    /**
+     * Defines whether the plugin should error on invalid hashes.
+     *
+     * When set to `false`, the plugin will only validate link pages and ignore hashes.
+     *
+     * @default true
+     */
+    errorOnInvalidHashes: z.boolean().default(true),
     /**
      * Defines a list of links or glob patterns that should be excluded from validation.
      *

package/libs/remark.ts

@@ -81,7 +81,7 @@ export const remarkStarlightLinksValidator: Plugin<[{ base: string; srcDir: URL
             }
           }
 
-          if (node.name !== 'a') {
+          if (node.name !== 'a' && node.name !== 'LinkCard' && node.name !== 'LinkButton') {
             break
           }
 

package/libs/validation.ts

@@ -15,7 +15,7 @@ import { getValidationData, type Headings } from './remark'
 
 export const ValidationErrorType = {
   InconsistentLocale: 'inconsistent locale',
-  InvalidAnchor: 'invalid anchor',
+  InvalidHash: 'invalid hash',
   InvalidLink: 'invalid link',
   RelativeLink: 'relative link',
   TrailingSlash: 'trailing slash',
@@ -59,7 +59,9 @@ export function validateLinks(
       }
 
       if (link.startsWith('#')) {
-        validateSelfAnchor(validationContext)
+        if (options.errorOnInvalidHashes) {
+          validateSelfHash(validationContext)
+        }
       } else {
         validateLink(validationContext)
       }
@@ -151,7 +153,9 @@ function validateLink(context: ValidationContext) {
   }
 
   if (hash && !fileHeadings.includes(hash)) {
-    addError(errors, filePath, link, ValidationErrorType.InvalidAnchor)
+    if (options.errorOnInvalidHashes) {
+      addError(errors, filePath, link, ValidationErrorType.InvalidHash)
+    }
     return
   }
 
@@ -176,9 +180,9 @@ function getFileHeadings(path: string, { headings, localeConfig, options }: Vali
 }
 
 /**
- * Validate a link to an anchor in the same page.
+ * Validate a link to an hash in the same page.
  */
-function validateSelfAnchor({ errors, link, filePath, headings }: ValidationContext) {
+function validateSelfHash({ errors, link, filePath, headings }: ValidationContext) {
   const sanitizedHash = link.replace(/^#/, '')
   const fileHeadings = headings.get(filePath)
 
@@ -187,7 +191,7 @@ function validateSelfAnchor({ errors, link, filePath, headings }: ValidationCont
   }
 
   if (!fileHeadings.includes(sanitizedHash)) {
-    addError(errors, filePath, link, 'invalid anchor')
+    addError(errors, filePath, link, ValidationErrorType.InvalidHash)
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-links-validator",
-  "version": "0.10.1",
+  "version": "0.12.0",
   "license": "MIT",
   "description": "Starlight plugin to validate internal links.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -20,12 +20,12 @@
     "unist-util-visit": "5.0.0"
   },
   "devDependencies": {
-    "@astrojs/starlight": "0.15.0",
+    "@astrojs/starlight": "0.26.1",
     "@types/hast": "3.0.3",
     "@types/mdast": "4.0.3",
     "@types/node": "18.17.18",
     "@types/picomatch": "2.3.3",
-    "astro": "4.0.4",
+    "astro": "4.8.6",
     "mdast-util-mdx-jsx": "3.0.0",
     "remark-custom-heading-id": "2.0.0",
     "typescript": "5.1.3",