starlight-links-validator 0.13.4 → 0.14.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# starlight-links-validator
+
+## 0.14.0
+
+### Minor Changes
+
+- [#77](https://github.com/HiDeoo/starlight-links-validator/pull/77) [`486a379`](https://github.com/HiDeoo/starlight-links-validator/commit/486a379c5bda40584126c376e14a3c82c23bd449) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for Astro v5, drops support for Astro v4.
+
+  ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now `0.30.0`.
+
+  Please follow the [upgrade guide](https://github.com/withastro/starlight/releases/tag/%40astrojs/starlight%400.30.0) to update your project.
+
+  When using the plugin with the [Content Layer API](https://docs.astro.build/en/guides/content-collections), the plugin will now automatically invalidate the content layer cache so that all links can be properly validated. To avoid unnecessary cache invalidation, it is recommended to conditionally use the plugin only when necessary. Check out the new [“Conditional Validation”](https://starlight-links-validator.vercel.app/guides/conditional-validation/) guide for more information.
+
+  ⚠️ **BREAKING CHANGE:** Due to a [regression](https://github.com/withastro/astro/issues/12778) in Astro v5, links to pages with [custom IDs/slugs](https://docs.astro.build/en/guides/content-collections/#defining-custom-ids) can no longer be validated and will be flagged as invalid. If you rely on this feature, please stay on a previous version of Starlight and Astro in the meantime.

package/index.ts

@@ -2,6 +2,7 @@ import type { StarlightPlugin } from '@astrojs/starlight/types'
 import { AstroError } from 'astro/errors'
 import { z } from 'astro/zod'
 
+import { clearContentLayerCache } from './libs/astro'
 import { remarkStarlightLinksValidator } from './libs/remark'
 import { logErrors, validateLinks } from './libs/validation'
 
@@ -74,11 +75,13 @@ export default function starlightLinksValidatorPlugin(
         addIntegration({
           name: 'starlight-links-validator-integration',
           hooks: {
-            'astro:config:setup': ({ command, updateConfig }) => {
+            'astro:config:setup': async ({ command, updateConfig }) => {
               if (command !== 'build') {
                 return
               }
 
+              await clearContentLayerCache(astroConfig, logger)
+
               updateConfig({
                 markdown: {
                   remarkPlugins: [

package/libs/astro.ts

@@ -0,0 +1,17 @@
+import fs from 'node:fs'
+
+import type { AstroConfig, AstroIntegrationLogger } from 'astro'
+
+const dataStoreFile = 'data-store.json'
+
+export async function clearContentLayerCache(config: AstroConfig, logger: AstroIntegrationLogger) {
+  const dataStore = getDataStoreFile(config)
+  if (fs.existsSync(dataStore)) {
+    logger.info('Invalidating content layer cache…')
+    await fs.promises.rm(dataStore, { force: true })
+  }
+}
+
+function getDataStoreFile(config: AstroConfig) {
+  return new URL(dataStoreFile, config.cacheDir)
+}

package/libs/remark.ts

@@ -26,11 +26,12 @@ export const remarkStarlightLinksValidator: Plugin<[{ base: string; srcDir: URL
   srcDir,
 }) {
   return (tree, file) => {
-    if (file.data.astro?.frontmatter?.draft) return
+    if (file.data.astro?.frontmatter?.['draft']) return
 
     const slugger = new GitHubSlugger()
     const filePath = normalizeFilePath(base, srcDir, file.history[0])
-    const slug = file.data.astro?.frontmatter?.slug
+    const slug: string | undefined =
+      typeof file.data.astro?.frontmatter?.['slug'] === 'string' ? file.data.astro.frontmatter['slug'] : undefined
 
     const fileHeadings: string[] = []
     const fileLinks: string[] = []
@@ -202,14 +203,3 @@ interface MdxIdAttribute {
   type: 'mdxJsxAttribute'
   value: string
 }
-
-declare module 'vfile' {
-  interface DataMap {
-    astro?: {
-      frontmatter?: {
-        draft?: boolean
-        slug?: string
-      }
-    }
-  }
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-links-validator",
-  "version": "0.13.4",
+  "version": "0.14.0",
   "license": "MIT",
   "description": "Starlight plugin to validate internal links.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -10,39 +10,36 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@types/picomatch": "2.3.3",
-    "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",
-    "picomatch": "4.0.2",
-    "unist-util-visit": "5.0.0"
+    "@types/picomatch": "^3.0.1",
+    "github-slugger": "^2.0.0",
+    "hast-util-from-html": "^2.0.3",
+    "hast-util-has-property": "^3.0.0",
+    "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": {
-    "@astrojs/starlight": "0.26.1",
-    "@types/hast": "3.0.3",
-    "@types/mdast": "4.0.3",
-    "@types/node": "18.17.18",
-    "astro": "4.8.6",
-    "mdast-util-mdx-jsx": "3.0.0",
-    "remark-custom-heading-id": "2.0.0",
-    "typescript": "5.1.3",
-    "unified": "11.0.4",
-    "vfile": "6.0.1",
-    "vitest": "1.0.4"
+    "@types/hast": "^3.0.4",
+    "@types/mdast": "^4.0.4",
+    "@types/node": "^18.19.68",
+    "mdast-util-mdx-jsx": "^3.1.3",
+    "remark-custom-heading-id": "^2.0.0",
+    "unified": "^11.0.5",
+    "vfile": "^6.0.3",
+    "vitest": "2.1.6"
   },
   "peerDependencies": {
-    "@astrojs/starlight": ">=0.15.0",
-    "astro": ">=4.0.0"
+    "@astrojs/starlight": ">=0.15.0"
   },
   "engines": {
-    "node": ">=18.14.1"
+    "node": ">=18.17.1"
   },
   "packageManager": "pnpm@8.6.3",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "sideEffects": false,
   "keywords": [
@@ -55,11 +52,12 @@
   "homepage": "https://github.com/HiDeoo/starlight-links-validator",
   "repository": {
     "type": "git",
-    "url": "https://github.com/HiDeoo/starlight-links-validator.git"
+    "url": "https://github.com/HiDeoo/starlight-links-validator.git",
+    "directory": "packages/starlight-links-validator"
   },
   "bugs": "https://github.com/HiDeoo/starlight-links-validator/issues",
   "scripts": {
     "test": "vitest",
-    "lint": "prettier -c --cache . && eslint . --cache --max-warnings=0"
+    "lint": "eslint . --cache --max-warnings=0"
   }
 }