starlight-versions 0.5.1 → 0.5.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # starlight-versions
 
+## 0.5.3
+
+### Patch Changes
+
+- [#29](https://github.com/HiDeoo/starlight-versions/pull/29) [`3cc3e30`](https://github.com/HiDeoo/starlight-versions/commit/3cc3e30d6b778c7615cee9c2fcb01f6225b6cb84) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes an issue with versioned sidebars including a link to the homepage.
+
+## 0.5.2
+
+### Patch Changes
+
+- [#24](https://github.com/HiDeoo/starlight-versions/pull/24) [`113cb97`](https://github.com/HiDeoo/starlight-versions/commit/113cb975b6acc3dc3dc6d1c252048e62248dc9ed) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes an issue with symlinked version directories.
+
 ## 0.5.1
 
 ### Patch Changes

package/libs/fs.ts

@@ -1,5 +1,6 @@
-import type { PathLike } from 'node:fs'
+import type { Dirent, PathLike } from 'node:fs'
 import fs from 'node:fs/promises'
+import path from 'node:path'
 
 import { ensureTrailingSlash } from './path'
 
@@ -60,6 +61,17 @@ export function ensureDirectory(directory: PathLike) {
   return fs.mkdir(directory, { recursive: true })
 }
 
+// Checks if the entry is a directory or a symbolic link to a directory.
+export async function isDirectoryEntry(entry: Dirent) {
+  if (entry.isDirectory()) return true
+  if (!entry.isSymbolicLink()) return false
+
+  const entryPath = path.join(entry.parentPath, entry.name)
+  const stats = await fs.stat(entryPath)
+
+  return stats.isDirectory()
+}
+
 export type CopyDirectoryCallback = (
   entry:
     | { type: 'file'; content: string; url: URL }

package/libs/starlight.ts

@@ -76,6 +76,7 @@ export function addPrefixToSidebarConfig(
 }
 
 function addPrefixToSlug(prefix: string, slug: string) {
+  if (slug === '' || slug === 'index') return prefix
   return `${prefix}/${slug}`
 }
 

package/libs/versions.ts

@@ -5,7 +5,15 @@ import { z } from 'astro/zod'
 import type { StarlightVersionsConfig } from '..'
 import type { DocsVersionsConfig } from '../schema'
 
-import { copyDirectory, copyFile, ensureDirectory, listDirectory, readJSONFile, writeJSONFile } from './fs'
+import {
+  copyDirectory,
+  copyFile,
+  ensureDirectory,
+  isDirectoryEntry,
+  listDirectory,
+  readJSONFile,
+  writeJSONFile,
+} from './fs'
 import { transformMarkdown } from './markdown'
 import { ensureTrailingSlash, getExtension, stripExtension, stripLeadingSlash, stripTrailingSlash } from './path'
 import { throwPluginError } from './plugin'
@@ -317,7 +325,13 @@ async function checkForNewVersion(config: StarlightVersionsConfig, docsDir: URL)
   let newVersion: Version | undefined
 
   const docsDirEntries = await listDirectory(docsDir)
-  const docsDirDirectories = new Set(docsDirEntries.filter((entry) => entry.isDirectory()).map((dirent) => dirent.name))
+  const docsDirDirectories = new Set<string>()
+
+  for (const entry of docsDirEntries) {
+    if (await isDirectoryEntry(entry)) {
+      docsDirDirectories.add(entry.name)
+    }
+  }
 
   for (const version of config.versions) {
     if (!docsDirDirectories.has(version.slug)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-versions",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "license": "MIT",
   "description": "Starlight plugin to version documentation pages.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",