starlight-versions 0.10.0 → 0.10.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # starlight-versions
 
+## 0.10.1
+
+### Patch Changes
+
+- [#80](https://github.com/HiDeoo/starlight-versions/pull/80) [`dd385c8`](https://github.com/HiDeoo/starlight-versions/commit/dd385c88940cc36e5733d0f082a04907f44bb2f0) Thanks [@kozmagabor](https://github.com/kozmagabor)! - Fixes versioning of assets stored alongside documentation pages.
+
 ## 0.10.0
 
 ### Minor Changes

package/libs/fs.ts

@@ -32,13 +32,17 @@ export async function copyDirectory(sourceDir: URL, destDir: URL, callback: Copy
       await copyDirectory(source, dest, callback, false)
     } else if (entry.isFile()) {
       const source = new URL(entry.name, sourceDir)
-      const content = await fs.readFile(source, 'utf8')
 
-      const updatedContent = await callback({ type: 'file', content, url: source })
+      const updatedContent = await callback({ type: 'file', url: source })
+      if (updatedContent === true) continue
 
-      if (typeof updatedContent !== 'string') continue
+      const dest = new URL(entry.name, destDir)
 
-      await fs.writeFile(new URL(entry.name, destDir), updatedContent)
+      if (updatedContent === undefined) {
+        await copyFile(source, dest)
+      } else if (typeof updatedContent === 'string') {
+        await fs.writeFile(dest, updatedContent)
+      }
     }
   }
 }
@@ -72,8 +76,12 @@ export async function isDirectoryEntry(entry: Dirent) {
   return stats.isDirectory()
 }
 
+/**
+ * Defines how entries are handled when copying a directory with `copyDirectory()`.
+ *
+ * - For files, return `undefined` to copy as-is, a string to write transformed content, or `true` to skip.
+ * - For directories, return `undefined` to use the default destination, a `URL` to override it, or `true` to skip.
+ */
 export type CopyDirectoryCallback = (
-  entry:
-    | { type: 'file'; content: string; url: URL }
-    | { type: 'directory'; name: string; isRoot: boolean; source: URL; dest: URL },
-) => Promise<string | boolean | URL>
+  entry: { type: 'file'; url: URL } | { type: 'directory'; name: string; isRoot: boolean; source: URL; dest: URL },
+) => Promise<string | true | URL | undefined>

package/libs/markdown.ts

@@ -246,8 +246,10 @@ function addVersionToLink(link: string, file: VFile) {
 
 function addVersionToAstroAsset(asset: string, file: VFile) {
   assert.ok(file.data.version, 'A version must be provided to add a version to an Astro asset.')
+  assert.ok(file.data.docsDir, 'A docs directory must be provided to add a version to an Astro asset.')
 
   const source = new URL(asset, file.data.url)
+  if (source.href.startsWith(file.data.docsDir.href)) return asset
 
   const segments = asset.split('/')
   segments.splice(-1, 0, file.data.version.slug)
@@ -287,6 +289,7 @@ function isPublicAsset(asset: string) {
 export interface TransformContext {
   assets: VersionAsset[]
   base: string
+  docsDir: URL
   excludedSlugs: string[]
   locale: string | undefined
   publicDir: URL

package/libs/versions.ts

@@ -40,6 +40,9 @@ import {
 
 const currentVersionSidebarGroupLabel = Symbol('StarlightVersionsCurrentVersionSidebarGroupLabel')
 
+// https://github.com/withastro/starlight/blob/23207221169b31e0cc210451a39a19c80fa1f69e/packages/starlight/loaders.ts#L6
+const docsExtensions = new Set(['.markdown', '.mdown', '.mkdn', '.mkd', '.mdwn', '.md', '.mdx'])
+
 export const VersionBaseSchema = z.object({
   /**
    * The version redirect strategy used when navigating to this version:
@@ -105,7 +108,7 @@ export async function ensureNewVersion(
         }
 
         // Do not skip other non-root directories.
-        return false
+        return
       }
 
       // Skip root version directories.
@@ -114,19 +117,21 @@ export async function ensureNewVersion(
       const localeDir = locales.find((locale) => locale === entry.name)
 
       // Copy root directories not matching any locale.
-      if (!localeDir) return false
+      if (!localeDir) return
 
       // Otherwise, swap the locale and version directories.
       return new URL(`../../${localeDir}/${newVersion.slug}/`, entry.dest)
     }
 
-    if (excludedDocs.has(getDocPath(docsDir, entry.url))) return false
+    if (!docsExtensions.has(getExtension(entry.url.pathname))) return
+    if (excludedDocs.has(getDocPath(docsDir, entry.url))) return true
 
     const slug = getDocSlug(docsDir, entry.url)
 
-    const md = await transformMarkdown(entry.content, {
+    const md = await transformMarkdown(await fs.readFile(entry.url, 'utf8'), {
       assets: [],
       base: stripTrailingSlash(astroConfig.base),
+      docsDir,
       excludedSlugs,
       locale: getDocLocale(slug, starlightConfig),
       publicDir: astroConfig.publicDir,
@@ -497,7 +502,11 @@ async function getExcludedDocs(config: StarlightVersionsConfig, locales: string[
         continue
       }
 
-      if (!entry.isFile() || !config.exclude.some((excludeGlob) => path.posix.matchesGlob(docPath, excludeGlob))) {
+      if (
+        !entry.isFile() ||
+        !docsExtensions.has(getExtension(docPath)) ||
+        !config.exclude.some((excludeGlob) => path.posix.matchesGlob(docPath, excludeGlob))
+      ) {
         continue
       }
 

package/package.json

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