starlight-versions 0.7.1 → 0.8.1

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # starlight-versions
 
+## 0.8.1
+
+### Patch Changes
+
+- [#62](https://github.com/HiDeoo/starlight-versions/pull/62) [`3b6b14a`](https://github.com/HiDeoo/starlight-versions/commit/3b6b14a1e55f13aaf289e822f10dcead916e6c12) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Improves the error message logged when the plugin configuration is invalid.
+
+## 0.8.0
+
+### Minor Changes
+
+- [#60](https://github.com/HiDeoo/starlight-versions/pull/60) [`059b573`](https://github.com/HiDeoo/starlight-versions/commit/059b57361b2295fc72a79e805c3c44a33902d566) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for Astro v6, drops support for Astro v5.
+
+  ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now `0.38.0`.
+
+  Please follow the [upgrade guide](https://github.com/withastro/starlight/releases/tag/%40astrojs%2Fstarlight%400.38.0) to update your project.
+
 ## 0.7.1
 
 ### Patch Changes

package/components/VersionBanner.astro

@@ -7,7 +7,7 @@ import { getVersionFromSlug, getVersionURL } from '../libs/versions'
 const { entry } = Astro.locals.starlightRoute
 const { template } = Astro.locals.starlightRoute.entry.data
 
-const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, entry.slug)
+const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, entry.id)
 ---
 
 {

package/components/VersionNotice.astro

@@ -5,7 +5,7 @@ import starlightVersionsConfig from 'virtual:starlight-versions-config'
 
 import { getVersionFromSlug, getVersionURL } from '../libs/versions'
 
-const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, Astro.locals.starlightRoute.entry.slug)
+const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, Astro.locals.starlightRoute.entry.id)
 ---
 
 {

package/components/VersionSearch.astro

@@ -23,7 +23,7 @@ const pagefindTranslations = {
   ),
 }
 
-const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, entry.slug)
+const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, entry.id)
 const pageVersionIdentifier = getVersionIdentifier(pageVersion)
 
 const dataAttributes: DOMStringMap = {

package/index.ts

@@ -1,4 +1,5 @@
 import type { StarlightPlugin } from '@astrojs/starlight/types'
+import { z } from 'astro/zod'
 
 import { StarlightVersionsConfigSchema, type StarlightVersionsUserConfig } from './libs/config'
 import { overrideComponents, throwPluginError } from './libs/plugin'
@@ -13,7 +14,10 @@ export default function starlightVersionsPlugin(userConfig: StarlightVersionsUse
 
   if (!parsedConfig.success) {
     throwPluginError(
-      `The provided plugin configuration is invalid.\n${parsedConfig.error.issues.map((issue) => issue.message).join('\n')}`,
+      `Invalid starlight-versions configuration:
+
+${z.prettifyError(parsedConfig.error)}
+`,
     )
   }
 

package/libs/config.ts

@@ -9,6 +9,7 @@ export const StarlightVersionsConfigSchema = z
      */
     current: z
       .object({
+        ...VersionBaseSchema.shape,
         /**
          * The label used in the UI to represent the current version.
          *
@@ -16,8 +17,7 @@ export const StarlightVersionsConfigSchema = z
          */
         label: z.string().default('Latest'),
       })
-      .merge(VersionBaseSchema)
-      .default({}),
+      .prefault({}),
     /**
      * A list of all archived versions of the documentation.
      */

package/libs/markdown.ts

@@ -186,7 +186,7 @@ function handleImports(node: MdxjsEsm, file: VFile) {
 }
 
 function addVersionToLink(link: string, file: VFile) {
-  assert(file.data.version, 'A version must be provided to add a version to an Astro asset.')
+  assert.ok(file.data.version, 'A version must be provided to add a version to an Astro asset.')
 
   const base = file.data.base ?? ''
   const hasBase = file.data.base && link.startsWith(file.data.base)
@@ -210,7 +210,7 @@ function addVersionToLink(link: string, file: VFile) {
 }
 
 function addVersionToAstroAsset(asset: string, file: VFile) {
-  assert(file.data.version, 'A version must be provided to add a version to an Astro asset.')
+  assert.ok(file.data.version, 'A version must be provided to add a version to an Astro asset.')
 
   const source = new URL(asset, file.data.url)
 
@@ -225,7 +225,7 @@ function addVersionToAstroAsset(asset: string, file: VFile) {
 }
 
 function addVersionToPublicAsset(asset: string, file: VFile) {
-  assert(file.data.version, 'A version must be provided to add a version to an public asset.')
+  assert.ok(file.data.version, 'A version must be provided to add a version to an public asset.')
 
   const source = new URL(`.${asset}`, file.data.publicDir)
 

package/libs/versions.ts

@@ -40,25 +40,24 @@ export const VersionBaseSchema = z.object({
   redirect: z.union([z.literal('root'), z.literal('same-page')]).default('same-page'),
 })
 
-export const VersionSchema = z
-  .object({
-    /**
-     * An optional label used in the UI when displaying the version.
-     * If not provided, the version slug is used.
-     *
-     * @example 'v2.0'
-     * @example 'v3.1.2'
-     */
-    label: z.string().optional(),
-    /**
-     * The version slug used in URLs to identify the version and its content.
-     *
-     * @example '2.0'
-     * @example '3-1-2'
-     */
-    slug: z.string().refine((value) => stripLeadingSlash(stripTrailingSlash(value))),
-  })
-  .merge(VersionBaseSchema)
+export const VersionSchema = z.object({
+  ...VersionBaseSchema.shape,
+  /**
+   * An optional label used in the UI when displaying the version.
+   * If not provided, the version slug is used.
+   *
+   * @example 'v2.0'
+   * @example 'v3.1.2'
+   */
+  label: z.string().optional(),
+  /**
+   * The version slug used in URLs to identify the version and its content.
+   *
+   * @example '2.0'
+   * @example '3-1-2'
+   */
+  slug: z.string().refine((value) => stripLeadingSlash(stripTrailingSlash(value))),
+})
 
 export async function ensureNewVersion(
   config: StarlightVersionsConfig,

package/middleware.ts

@@ -9,11 +9,11 @@ export const onRequest = defineRouteMiddleware((context) => {
   const { entry, locale, pagination, sidebar } = starlightRoute
 
   starlightRoute.sidebar = getVersionSidebar(
-    getVersionFromSlug(starlightVersionsConfig, starlightConfig, entry.slug),
+    getVersionFromSlug(starlightVersionsConfig, starlightConfig, entry.id),
     sidebar,
   )
 
-  const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, entry.slug)
+  const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, entry.id)
 
   starlightRoute.pagination.prev = getPaginationLink(locale, pageVersion, pagination.prev)
   starlightRoute.pagination.next = getPaginationLink(locale, pageVersion, pagination.next)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-versions",
-  "version": "0.7.1",
+  "version": "0.8.1",
   "license": "MIT",
   "description": "Starlight plugin to version documentation pages.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -20,28 +20,28 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@pagefind/default-ui": "^1.2.0",
+    "@pagefind/default-ui": "^1.3.0",
     "github-slugger": "^2.0.0",
-    "mdast-util-mdx-jsx": "^3.1.3",
+    "mdast-util-mdx-jsx": "^3.2.0",
     "mdast-util-mdxjs-esm": "^2.0.1",
     "remark": "^15.0.1",
     "remark-directive": "^4.0.0",
     "remark-frontmatter": "^5.0.0",
-    "remark-mdx": "^3.1.0",
-    "unist-util-visit": "^5.0.0",
+    "remark-mdx": "^3.1.1",
+    "unist-util-visit": "^5.1.0",
     "vfile": "^6.0.3",
-    "yaml": "^2.6.1"
+    "yaml": "^2.8.2"
   },
   "devDependencies": {
     "@types/mdast": "^4.0.4",
-    "fast-glob": "^3.3.2",
-    "vitest": "2.1.6"
+    "fast-glob": "^3.3.3",
+    "vitest": "^4.0.18"
   },
   "peerDependencies": {
-    "@astrojs/starlight": ">=0.32.0"
+    "@astrojs/starlight": ">=0.38.0"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=22.12.0"
   },
   "publishConfig": {
     "access": "public"