starlight-versions 0.8.1 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # starlight-versions
 
+## 0.9.0
+
+### Minor Changes
+
+- [#68](https://github.com/HiDeoo/starlight-versions/pull/68) [`e313164`](https://github.com/HiDeoo/starlight-versions/commit/e31316400efde94bf27ac1b577e8867beecb27df) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now `0.39.0`.
+
+  Please use the `@astrojs/upgrade` command to upgrade your project:
+
+  ```sh
+  npx @astrojs/upgrade
+  ```
+
+## 0.8.2
+
+### Patch Changes
+
+- [#64](https://github.com/HiDeoo/starlight-versions/pull/64) [`5e26275`](https://github.com/HiDeoo/starlight-versions/commit/5e262755d6b8f61ba4c17f59f32ff0fa0ff87938) Thanks [@Hexalyse](https://github.com/Hexalyse)! - Fixes a Windows-only issue where archived docs could generate incorrect routes.
+
 ## 0.8.1
 
 ### Patch Changes

package/libs/starlight.ts

@@ -18,7 +18,7 @@ export function getFrontmatterNodeValue(frontmatter: StarlightFrontmatter) {
 }
 
 export function getDocSlug(docsDir: URL, doc: URL) {
-  const docPath = path.relative(url.fileURLToPath(docsDir), url.fileURLToPath(doc))
+  const docPath = path.relative(url.fileURLToPath(docsDir), url.fileURLToPath(doc)).replaceAll('\\', '/')
   const slug = slugifyPath(docPath)
 
   return slug === 'index' ? '/' : slug.replace(/\/index$/, '')
@@ -36,10 +36,7 @@ export function getDocLocale(slug: string, starlightConfig: StarlightUserConfig)
   return locales.find((locale) => locale === localeSegment)
 }
 
-export function addPrefixToSidebarConfig(
-  prefix: string,
-  sidebar: NonNullable<StarlightSidebarUserConfig>,
-): NonNullable<StarlightSidebarUserConfig> {
+export function addPrefixToSidebarConfig(prefix: string, sidebar: SidebarConfigInputItem[]): SidebarConfig {
   return sidebar.map((item) => {
     if (typeof item === 'string') {
       return addPrefixToSlug(prefix, item)
@@ -48,13 +45,12 @@ export function addPrefixToSidebarConfig(
         ...item,
         items: addPrefixToSidebarConfig(prefix, item.items),
       }
+    } else if (isSidebarLegacyAutoGroup(item)) {
+      return addPrefixToLegacyAutogeneratedGroup(prefix, item)
     } else if ('autogenerate' in item) {
       return {
         ...item,
-        autogenerate: {
-          ...item.autogenerate,
-          directory: path.posix.join(prefix, item.autogenerate.directory),
-        },
+        autogenerate: addPrefixToAutogenerate(prefix, item.autogenerate),
       }
     } else if ('slug' in item) {
       return {
@@ -75,6 +71,31 @@ export function addPrefixToSidebarConfig(
   })
 }
 
+function isSidebarLegacyAutoGroup(item: SidebarConfigInputItem): item is SidebarLegacyAutoGroup {
+  return typeof item === 'object' && 'autogenerate' in item && 'label' in item
+}
+
+function addPrefixToLegacyAutogeneratedGroup(prefix: string, item: SidebarLegacyAutoGroup): SidebarConfigItem {
+  const { autogenerate: legacyAutogenerate, ...group } = item
+  const autogenerate = addPrefixToAutogenerate(prefix, legacyAutogenerate)
+
+  if (group.collapsed !== undefined && autogenerate.collapsed === undefined) {
+    autogenerate.collapsed = group.collapsed
+  }
+
+  return {
+    ...group,
+    items: [{ autogenerate }],
+  }
+}
+
+function addPrefixToAutogenerate<T extends { directory: string }>(prefix: string, autogenerate: T): T {
+  return {
+    ...autogenerate,
+    directory: path.posix.join(prefix, autogenerate.directory),
+  }
+}
+
 function addPrefixToSlug(prefix: string, slug: string) {
   if (slug === '' || slug === 'index') return prefix
   return `${prefix}/${slug}`
@@ -97,4 +118,11 @@ interface StarlightFrontmatteHero {
 export type StarlightUserConfig = HookParameters<'config:setup'>['config']
 export type StarlightSidebarUserConfig = StarlightUserConfig['sidebar']
 
+type SidebarConfig = NonNullable<StarlightSidebarUserConfig>
+type SidebarConfigItem = SidebarConfig[number]
+type SidebarAutogenerateConfig = Extract<SidebarConfigItem, { autogenerate: { directory: string } }>['autogenerate']
+type SidebarGroupConfig = Extract<SidebarConfigItem, { items: SidebarConfig }>
+type SidebarLegacyAutoGroup = Omit<SidebarGroupConfig, 'items'> & { autogenerate: SidebarAutogenerateConfig }
+type SidebarConfigInputItem = SidebarConfigItem | SidebarLegacyAutoGroup
+
 export type StarlightSidebar = StarlightRouteData['sidebar']

package/libs/versions.ts

@@ -303,7 +303,7 @@ async function getSidebarVersionGroup(version: Version, srcDir: URL) {
   if (!versionConfig.sidebar) {
     return {
       label: version.slug,
-      autogenerate: { directory: version.slug },
+      items: [{ autogenerate: { directory: version.slug } }],
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-versions",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "license": "MIT",
   "description": "Starlight plugin to version documentation pages.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -38,7 +38,7 @@
     "vitest": "^4.0.18"
   },
   "peerDependencies": {
-    "@astrojs/starlight": ">=0.38.0"
+    "@astrojs/starlight": ">=0.39.0"
   },
   "engines": {
     "node": ">=22.12.0"