starlight-versions 0.4.0 → 0.5.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # starlight-versions
 
+## 0.5.1
+
+### Patch Changes
+
+- [#21](https://github.com/HiDeoo/starlight-versions/pull/21) [`42be6e3`](https://github.com/HiDeoo/starlight-versions/commit/42be6e30a54fcdd5bec0959b7f354a1bc3954c14) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a potential link generation issue when using the Astro [`base`](https://docs.astro.build/en/reference/configuration-reference/#base) option.
+
+## 0.5.0
+
+### Minor Changes
+
+- [#18](https://github.com/HiDeoo/starlight-versions/pull/18) [`a68d559`](https://github.com/HiDeoo/starlight-versions/commit/a68d55958731e03d6c3b6ddf04eb5775a75a6862) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The Starlight Versions plugin no longer [overrides](https://starlight.astro.build/guides/overriding-components/) the [`<Sidebar>`](https://starlight.astro.build/reference/overrides/#sidebar) and [`<Pagination>`](https://starlight.astro.build/reference/overrides/#pagination) components. If you were manually rendering `starlight-versions/components/VersionSidebar.astro` or `starlight-versions/components/VersionPagination.astro` in a custom override, you can now remove them.
+
+- [#18](https://github.com/HiDeoo/starlight-versions/pull/18) [`a68d559`](https://github.com/HiDeoo/starlight-versions/commit/a68d55958731e03d6c3b6ddf04eb5775a75a6862) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now version `0.32.0`.
+
+  Please use the `@astrojs/upgrade` command to upgrade your project:
+
+  ```sh
+  npx @astrojs/upgrade
+  ```
+
 ## 0.4.0
 
 ### Minor Changes

package/components/VersionBanner.astro

@@ -1,13 +1,13 @@
 ---
-import type { Props } from '@astrojs/starlight/props'
 import starlightConfig from 'virtual:starlight/user-config'
 import starlightVersionsConfig from 'virtual:starlight-versions-config'
 
 import { getVersionFromSlug, getVersionURL } from '../libs/versions'
 
-const { template } = Astro.props.entry['data']
+const { entry } = Astro.locals.starlightRoute
+const { template } = Astro.locals.starlightRoute.entry.data
 
-const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, Astro.props.entry.slug)
+const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, entry.slug)
 ---
 
 {

package/components/VersionNotice.astro

@@ -1,12 +1,11 @@
 ---
 import { Icon } from '@astrojs/starlight/components'
-import type { Props } from '@astrojs/starlight/props'
 import starlightConfig from 'virtual:starlight/user-config'
 import starlightVersionsConfig from 'virtual:starlight-versions-config'
 
 import { getVersionFromSlug, getVersionURL } from '../libs/versions'
 
-const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, Astro.props.entry.slug)
+const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, Astro.locals.starlightRoute.entry.slug)
 ---
 
 {

package/components/VersionSearch.astro

@@ -5,7 +5,6 @@
  */
 
 import { Icon } from '@astrojs/starlight/components'
-import type { Props } from '@astrojs/starlight/props'
 import '@pagefind/default-ui/css/ui.css'
 import project from 'virtual:starlight/project-context'
 import starlightConfig from 'virtual:starlight/user-config'
@@ -13,7 +12,7 @@ import starlightVersionsConfig from 'virtual:starlight-versions-config'
 
 import { getVersionFromSlug, getVersionIdentifier, getVersionURL } from '../libs/versions'
 
-const { entry } = Astro.props
+const { entry } = Astro.locals.starlightRoute
 
 const pagefindTranslations = {
   placeholder: Astro.locals.t('search.label'),

package/components/VersionSelect.astro

@@ -1,12 +1,11 @@
 ---
 import { Icon } from '@astrojs/starlight/components'
-import type { Props } from '@astrojs/starlight/props'
 import starlightConfig from 'virtual:starlight/user-config'
 import starlightVersionsConfig from 'virtual:starlight-versions-config'
 
 import { getVersionFromSlug, getVersionURL } from '../libs/versions'
 
-const { id } = Astro.props
+const { id } = Astro.locals.starlightRoute
 
 const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, id)
 ---

package/index.ts

@@ -21,11 +21,19 @@ export default function starlightVersionsPlugin(userConfig: StarlightVersionsUse
   return {
     name: 'starlight-versions-plugin',
     hooks: {
-      async setup({ addIntegration, astroConfig, command, config: starlightConfig, logger, updateConfig }) {
+      async 'config:setup'({
+        addIntegration,
+        addRouteMiddleware,
+        astroConfig,
+        command,
+        config: starlightConfig,
+        logger,
+        updateConfig,
+      }) {
         if (command !== 'dev' && command !== 'build') return
 
         try {
-          await ensureNewVersion(config, starlightConfig, astroConfig.srcDir, logger)
+          await ensureNewVersion(config, starlightConfig, astroConfig, logger)
         } catch (error) {
           throwPluginError(
             error instanceof Error ? error.message : 'An error occurred while creating a new documentation version.',
@@ -33,6 +41,8 @@ export default function starlightVersionsPlugin(userConfig: StarlightVersionsUse
         }
 
         try {
+          addRouteMiddleware({ entrypoint: 'starlight-versions/middleware' })
+
           const versionedSidebar = await getVersionedSidebar(config, starlightConfig.sidebar, astroConfig.srcDir)
 
           updateConfig({
@@ -40,8 +50,6 @@ export default function starlightVersionsPlugin(userConfig: StarlightVersionsUse
               starlightConfig,
               [
                 { name: 'ThemeSelect', fallback: 'VersionSelect' },
-                { name: 'Sidebar', fallback: 'VersionSidebar' },
-                { name: 'Pagination', fallback: 'VersionPagination' },
                 { name: 'Search', fallback: 'VersionSearch' },
                 { name: 'PageTitle', fallback: 'VersionNotice' },
                 { name: 'Banner', fallback: 'VersionBanner' },

package/libs/markdown.ts

@@ -187,9 +187,20 @@ 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.')
 
+  const base = file.data.base ?? ''
+  const hasBase = file.data.base && link.startsWith(file.data.base)
+
+  if (hasBase) {
+    link = link.replace(base, '')
+  }
+
   const segments = link.split('/')
   segments.splice(1, 0, file.data.version.slug)
 
+  if (hasBase) {
+    segments.splice(1, 0, stripLeadingSlash(base))
+  }
+
   return segments.join('/')
 }
 
@@ -235,6 +246,7 @@ function isPublicAsset(asset: string) {
 
 export interface TransformContext {
   assets: VersionAsset[]
+  base: string
   locale: string | undefined
   slug: string
   url: URL

package/libs/starlight.ts

@@ -1,9 +1,9 @@
 import path from 'node:path'
 import url from 'node:url'
 
-import type { Props } from '@astrojs/starlight/props'
+import type { StarlightRouteData } from '@astrojs/starlight/route-data'
 import type { docsSchema } from '@astrojs/starlight/schema'
-import type { StarlightPlugin } from '@astrojs/starlight/types'
+import type { HookParameters } from '@astrojs/starlight/types'
 import type { z } from 'astro/zod'
 import yaml from 'yaml'
 
@@ -93,7 +93,7 @@ interface StarlightFrontmatteHero {
   }
 }
 
-export type StarlightUserConfig = Parameters<StarlightPlugin['hooks']['setup']>['0']['config']
+export type StarlightUserConfig = HookParameters<'config:setup'>['config']
 export type StarlightSidebarUserConfig = StarlightUserConfig['sidebar']
 
-export type StarlightSidebar = Props['sidebar']
+export type StarlightSidebar = StarlightRouteData['sidebar']

package/libs/versions.ts

@@ -1,5 +1,5 @@
 import type { StarlightConfig } from '@astrojs/starlight/types'
-import type { AstroIntegrationLogger } from 'astro'
+import type { AstroConfig, AstroIntegrationLogger } from 'astro'
 import { z } from 'astro/zod'
 
 import type { StarlightVersionsConfig } from '..'
@@ -55,10 +55,10 @@ export const VersionSchema = z
 export async function ensureNewVersion(
   config: StarlightVersionsConfig,
   starlightConfig: StarlightUserConfig,
-  srcDir: URL,
+  astroConfig: AstroConfig,
   logger: AstroIntegrationLogger,
 ) {
-  const docsDir = new URL('content/docs/', srcDir)
+  const docsDir = new URL('content/docs/', astroConfig.srcDir)
   const newVersion = await checkForNewVersion(config, docsDir)
   const locales = Object.keys(starlightConfig.locales ?? {})
 
@@ -98,6 +98,7 @@ export async function ensureNewVersion(
 
     const md = await transformMarkdown(entry.content, {
       assets: [],
+      base: stripTrailingSlash(astroConfig.base),
       locale: getDocLocale(slug, starlightConfig),
       slug,
       url: entry.url,
@@ -113,7 +114,7 @@ export async function ensureNewVersion(
     await copyFile(asset.source, asset.dest)
   }
 
-  await makeVersionConfig(newVersion, starlightConfig, srcDir)
+  await makeVersionConfig(newVersion, starlightConfig, astroConfig.srcDir)
 
   logger.info(`Created new version '${newVersion.slug}'.`)
 }

package/middleware.ts

@@ -0,0 +1,33 @@
+import { defineRouteMiddleware, type StarlightRouteData } from '@astrojs/starlight/route-data'
+import starlightConfig from 'virtual:starlight/user-config'
+import starlightVersionsConfig from 'virtual:starlight-versions-config'
+
+import { getVersionFromPaginationLink, getVersionFromSlug, getVersionSidebar, type Version } from './libs/versions'
+
+export const onRequest = defineRouteMiddleware((context) => {
+  const { starlightRoute } = context.locals
+  const { entry, locale, pagination, sidebar } = starlightRoute
+
+  starlightRoute.sidebar = getVersionSidebar(
+    getVersionFromSlug(starlightVersionsConfig, starlightConfig, entry.slug),
+    sidebar,
+  )
+
+  const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, entry.slug)
+
+  starlightRoute.pagination.prev = getPaginationLink(locale, pageVersion, pagination.prev)
+  starlightRoute.pagination.next = getPaginationLink(locale, pageVersion, pagination.next)
+})
+
+function getPaginationLink(locale: string | undefined, currentVersion: Version | undefined, link: PaginationLink) {
+  if (!link) return undefined
+
+  const linkVersion = getVersionFromPaginationLink(starlightVersionsConfig, link.href, locale)
+
+  // If the current version is not the same as the link version, remove the link.
+  return (currentVersion === undefined && linkVersion === undefined) || currentVersion?.slug === linkVersion?.slug
+    ? link
+    : undefined
+}
+
+type PaginationLink = StarlightRouteData['pagination']['next']

package/overrides/Banner.astro

@@ -1,9 +1,8 @@
 ---
 import Default from '@astrojs/starlight/components/Banner.astro'
-import type { Props } from '@astrojs/starlight/props'
 
 import VersionBanner from '../components/VersionBanner.astro'
 ---
 
-<VersionBanner {...Astro.props} />
-<Default {...Astro.props}><slot /></Default>
+<VersionBanner />
+<Default><slot /></Default>

package/overrides/PageTitle.astro

@@ -1,9 +1,8 @@
 ---
 import Default from '@astrojs/starlight/components/PageTitle.astro'
-import type { Props } from '@astrojs/starlight/props'
 
 import VersionNotice from '../components/VersionNotice.astro'
 ---
 
-<Default {...Astro.props}><slot /></Default>
-<VersionNotice {...Astro.props} />
+<Default><slot /></Default>
+<VersionNotice />

package/overrides/Search.astro

@@ -1,7 +1,5 @@
 ---
-import type { Props } from '@astrojs/starlight/props'
-
 import VersionSearch from '../components/VersionSearch.astro'
 ---
 
-<VersionSearch {...Astro.props} />
+<VersionSearch />

package/overrides/ThemeSelect.astro

@@ -1,9 +1,8 @@
 ---
 import Default from '@astrojs/starlight/components/ThemeSelect.astro'
-import type { Props } from '@astrojs/starlight/props'
 
 import VersionSelect from '../components/VersionSelect.astro'
 ---
 
-<VersionSelect {...Astro.props} />
-<Default {...Astro.props}><slot /></Default>
+<VersionSelect />
+<Default><slot /></Default>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-versions",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "license": "MIT",
   "description": "Starlight plugin to version documentation pages.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -10,15 +10,12 @@
     "./loader": "./loader.ts",
     "./components/VersionBanner.astro": "./components/VersionBanner.astro",
     "./components/VersionNotice.astro": "./components/VersionNotice.astro",
-    "./components/VersionPagination.astro": "./components/VersionPagination.astro",
     "./components/VersionSearch.astro": "./components/VersionSearch.astro",
     "./components/VersionSelect.astro": "./components/VersionSelect.astro",
-    "./components/VersionSidebar.astro": "./components/VersionSidebar.astro",
+    "./middleware": "./middleware.ts",
     "./overrides/Banner.astro": "./overrides/Banner.astro",
     "./overrides/PageTitle.astro": "./overrides/PageTitle.astro",
-    "./overrides/Pagination.astro": "./overrides/Pagination.astro",
     "./overrides/Search.astro": "./overrides/Search.astro",
-    "./overrides/Sidebar.astro": "./overrides/Sidebar.astro",
     "./overrides/ThemeSelect.astro": "./overrides/ThemeSelect.astro",
     "./package.json": "./package.json"
   },
@@ -40,7 +37,7 @@
     "vitest": "2.1.6"
   },
   "peerDependencies": {
-    "@astrojs/starlight": ">=0.30.0"
+    "@astrojs/starlight": ">=0.32.0"
   },
   "engines": {
     "node": ">=18"

package/components/VersionPagination.astro

@@ -1,34 +0,0 @@
----
-import Default from '@astrojs/starlight/components/Pagination.astro'
-import type { Props } from '@astrojs/starlight/props'
-import starlightConfig from 'virtual:starlight/user-config'
-import starlightVersionsConfig from 'virtual:starlight-versions-config'
-
-import { getVersionFromPaginationLink, getVersionFromSlug } from '../libs/versions'
-import type { Version } from '../libs/versions'
-
-const { entry, locale, pagination } = Astro.props
-
-type PaginationLink = typeof Astro.props.pagination.next
-
-function getPaginationLink(currentVersion: Version | undefined, link: PaginationLink) {
-  if (!link) return undefined
-
-  const linkVersion = getVersionFromPaginationLink(starlightVersionsConfig, link.href, locale)
-
-  // If the current version is not the same as the link version, remove the link.
-  return (currentVersion === undefined && linkVersion === undefined) || currentVersion?.slug === linkVersion?.slug
-    ? link
-    : undefined
-}
-
-const pageVersion = getVersionFromSlug(starlightVersionsConfig, starlightConfig, entry.slug)
----
-
-<Default
-  {...Astro.props}
-  pagination={{
-    prev: getPaginationLink(pageVersion, pagination.prev),
-    next: getPaginationLink(pageVersion, pagination.next),
-  }}><slot /></Default
->

package/components/VersionSidebar.astro

@@ -1,15 +0,0 @@
----
-import Default from '@astrojs/starlight/components/Sidebar.astro'
-import type { Props } from '@astrojs/starlight/props'
-import starlightConfig from 'virtual:starlight/user-config'
-import starlightVersionsConfig from 'virtual:starlight-versions-config'
-
-import { getVersionFromSlug, getVersionSidebar } from '../libs/versions'
-
-const sidebar = getVersionSidebar(
-  getVersionFromSlug(starlightVersionsConfig, starlightConfig, Astro.props.entry.slug),
-  Astro.props.sidebar,
-)
----
-
-<Default {...Astro.props} {sidebar}><slot /></Default>

package/overrides/Pagination.astro

@@ -1,7 +0,0 @@
----
-import type { Props } from '@astrojs/starlight/props'
-
-import VersionPagination from '../components/VersionPagination.astro'
----
-
-<VersionPagination {...Astro.props} />

package/overrides/Sidebar.astro

@@ -1,7 +0,0 @@
----
-import type { Props } from '@astrojs/starlight/props'
-
-import VersionSidebar from '../components/VersionSidebar.astro'
----
-
-<VersionSidebar {...Astro.props} />