starlight-obsidian 0.10.1 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # starlight-obsidian
 
+## 0.12.0
+
+### Minor Changes
+
+- [#70](https://github.com/HiDeoo/starlight-obsidian/pull/70) [`877dbb6`](https://github.com/HiDeoo/starlight-obsidian/commit/877dbb65ac7beff9e3110db1ac1ba5ec936de342) 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.11.0
+
+### Minor Changes
+
+- [#67](https://github.com/HiDeoo/starlight-obsidian/pull/67) [`2969770`](https://github.com/HiDeoo/starlight-obsidian/commit/296977054e79da21b3b081f245b9e4ed69d26066) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Improves error message when the `output` directory configuration option is invalid.
+
+- [#69](https://github.com/HiDeoo/starlight-obsidian/pull/69) [`619d371`](https://github.com/HiDeoo/starlight-obsidian/commit/619d371f1a14d48cf68702f28245ac42deee4a39) Thanks [@AsterisMono](https://github.com/AsterisMono)! - Adds support for translating the generated vault pages sidebar group label.
+
 ## 0.10.1
 
 ### Patch Changes

package/index.ts

@@ -6,6 +6,7 @@ import { z } from 'astro/zod'
 
 import { starlightObsidianIntegration } from './libs/integration'
 import { getObsidianPaths, getVault } from './libs/obsidian'
+import { stripLeadingAndTrailingSlashes } from './libs/path'
 import { throwUserError } from './libs/plugin'
 import { addObsidianFiles, getSidebarFromConfig, getSidebarGroupPlaceholder, type SidebarGroup } from './libs/starlight'
 
@@ -58,14 +59,25 @@ const starlightObsidianConfigSchema = z.object({
        */
       singleDollarTextMath: z.boolean().default(true),
     })
-    .default({}),
+    .prefault({}),
   /**
    * The name of the output directory containing the generated Obsidian vault pages relative to the `src/content/docs/`
    * directory.
    *
    * @default 'notes'
    */
-  output: z.string().default('notes'),
+  output: z
+    .string()
+    .default('notes')
+    .refine(
+      (value) => {
+        const label = stripLeadingAndTrailingSlashes(value)
+        return label !== '' && label !== '.' && !label.startsWith('..')
+      },
+      {
+        message: "The `output` directory cannot be empty, '.', or start with '..'.",
+      },
+    ),
   /**
    * Whether the Starlight Obsidian plugin should skip the generation of the Obsidian vault pages.
    *
@@ -95,11 +107,14 @@ const starlightObsidianConfigSchema = z.object({
       /**
        * The generated vault pages sidebar group label.
        *
+       * The value can be a string, or for multilingual sites, an object with values for each different locale.
+       * When using the object form, the keys must be BCP-47 tags (e.g. `en`, `ar`, or `zh-CN`).
+       *
        * @default 'Notes'
        */
-      label: z.string().default('Notes'),
+      label: z.union([z.string(), z.record(z.string(), z.string())]).default('Notes'),
     })
-    .default({}),
+    .prefault({}),
   /**
    * Determines if the table of contents top-level heading should be the Starlight default one ("Overview") or the page
    * title.
@@ -179,7 +194,7 @@ function makeStarlightObsidianPlugin(
               ...overrideStarlightComponent(starlightConfig.components, logger, 'PageTitle'),
             },
             customCss: [...(starlightConfig.customCss ?? []), 'starlight-obsidian/styles/common'],
-            sidebar: getSidebarFromConfig(config, starlightConfig.sidebar, sidebarGroup),
+            sidebar: getSidebarFromConfig(config, starlightConfig, sidebarGroup),
           }
 
           if (config.skipGeneration) {

package/libs/path.ts

@@ -52,3 +52,17 @@ export function slashify(filePath: string) {
 export function osPath(filePath: string) {
   return filePath.replaceAll('/', path.sep)
 }
+
+function stripLeadingSlash(href: string) {
+  if (href.startsWith('/')) href = href.slice(1)
+  return href
+}
+
+function stripTrailingSlash(href: string) {
+  if (href.endsWith('/')) href = href.slice(0, -1)
+  return href
+}
+
+export function stripLeadingAndTrailingSlashes(href: string): string {
+  return stripTrailingSlash(stripLeadingSlash(href))
+}

package/libs/rehype.ts

@@ -15,8 +15,7 @@ export function rehypeStarlightObsidian() {
         const lastChild = node.children.at(-1)
 
         if (
-          !lastChild ||
-          lastChild.type !== 'element' ||
+          lastChild?.type !== 'element' ||
           !(lastChild.tagName === 'p' || lastChild.tagName === 'ul' || lastChild.tagName === 'ol')
         ) {
           return CONTINUE

package/libs/remark.ts

@@ -509,9 +509,7 @@ function getFrontmatterNodeValue(file: VFile, obsidianFrontmatter?: ObsidianFron
   }
 
   if (file.data.includeKatexStyles) {
-    if (!frontmatter.head) {
-      frontmatter.head = []
-    }
+    frontmatter.head ??= []
 
     frontmatter.head.push({
       tag: 'link',
@@ -525,9 +523,7 @@ function getFrontmatterNodeValue(file: VFile, obsidianFrontmatter?: ObsidianFron
   const ogImage = obsidianFrontmatter?.cover ?? obsidianFrontmatter?.image
 
   if (ogImage && isAbsoluteUrl(ogImage)) {
-    if (!frontmatter.head) {
-      frontmatter.head = []
-    }
+    frontmatter.head ??= []
 
     if (!frontmatter.head.some((tag) => tag.attrs['property'] === 'og:image')) {
       frontmatter.head.push({ tag: 'meta', attrs: { property: 'og:image', content: ogImage } })
@@ -632,9 +628,7 @@ function handleImagesWithSize(node: Image, context: VisitorContext, type: 'asset
   } else {
     const importId = generateAssetImportId()
 
-    if (!context.file.data.assetImports) {
-      context.file.data.assetImports = []
-    }
+    context.file.data.assetImports ??= []
 
     context.file.data.assetImports.push([importId, node.url])
 

package/libs/starlight.ts

@@ -1,7 +1,7 @@
 import fs from 'node:fs/promises'
 import path from 'node:path'
 
-import type { StarlightUserConfig } from '@astrojs/starlight/types'
+import type { HookParameters, StarlightUserConfig } from '@astrojs/starlight/types'
 import type { AstroIntegrationLogger } from 'astro'
 
 import type { StarlightObsidianConfig } from '..'
@@ -75,23 +75,39 @@ export function getSidebarGroupPlaceholder(label = starlightObsidianSidebarGroup
 
 export function getSidebarFromConfig(
   config: StarlightObsidianConfig,
-  sidebar: StarlightUserConfig['sidebar'],
+  starlightConfig: HookParameters<'config:setup'>['config'],
   sidebarGroupPlaceholder: SidebarGroup,
 ): StarlightUserConfig['sidebar'] {
-  if (!sidebar || sidebar.length === 0) {
-    return sidebar
+  if (!starlightConfig.sidebar || starlightConfig.sidebar.length === 0) {
+    return starlightConfig.sidebar
   }
 
   function replaceSidebarGroupPlaceholder(group: SidebarManualGroup): SidebarItem {
     if (group.label === sidebarGroupPlaceholder.label) {
-      return {
+      const defaultLocaleConfig = starlightConfig.locales?.[starlightConfig.defaultLocale ?? 'root']
+      const label =
+        typeof config.sidebar.label === 'string'
+          ? config.sidebar.label
+          : config.sidebar.label[defaultLocaleConfig?.lang ?? 'en']
+
+      if (!label || label.length === 0) {
+        throw new Error('The generated vault pages sidebar group label must have a key for the default language.')
+      }
+
+      const group: SidebarGroup = {
         autogenerate: {
           collapsed: config.sidebar.collapsedFolders ?? config.sidebar.collapsed,
           directory: config.output,
         },
         collapsed: config.sidebar.collapsed,
-        label: config.sidebar.label,
+        label,
       }
+
+      if (typeof config.sidebar.label !== 'string') {
+        group['translations'] = config.sidebar.label
+      }
+
+      return group
     }
 
     if (isSidebarGroup(group)) {
@@ -106,7 +122,7 @@ export function getSidebarFromConfig(
     return group
   }
 
-  return sidebar.map((item) => {
+  return starlightConfig.sidebar.map((item) => {
     return isSidebarGroup(item) ? replaceSidebarGroupPlaceholder(item) : item
   })
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-obsidian",
-  "version": "0.10.1",
+  "version": "0.12.0",
   "license": "MIT",
   "description": "Starlight plugin to publish Obsidian vaults.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -17,43 +17,42 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@astro-community/astro-embed-twitter": "^0.5.8",
-    "@astro-community/astro-embed-youtube": "^0.5.6",
+    "@astro-community/astro-embed-twitter": "^0.5.11",
+    "@astro-community/astro-embed-youtube": "^0.5.10",
     "decode-uri-component": "^0.4.1",
     "github-slugger": "^2.0.0",
-    "globby": "^14.0.2",
-    "hast-util-to-html": "^9.0.4",
-    "is-absolute-url": "^4.0.1",
-    "mdast-util-find-and-replace": "^3.0.1",
-    "mdast-util-from-markdown": "^2.0.2",
-    "mdast-util-to-hast": "^13.2.0",
-    "nanoid": "^5.0.9",
+    "globby": "^16.1.1",
+    "hast-util-to-html": "^9.0.5",
+    "is-absolute-url": "^5.0.0",
+    "mdast-util-find-and-replace": "^3.0.2",
+    "mdast-util-from-markdown": "^2.0.3",
+    "mdast-util-to-hast": "^13.2.1",
+    "nanoid": "^5.1.6",
     "rehype": "^13.0.2",
     "rehype-katex": "^7.0.1",
     "rehype-mermaid": "^2.1.0",
     "remark": "^15.0.1",
     "remark-frontmatter": "^5.0.0",
-    "remark-gfm": "^4.0.0",
+    "remark-gfm": "^4.0.1",
     "remark-math": "^6.0.0",
-    "unist-util-visit": "^5.0.0",
+    "unist-util-visit": "^5.1.0",
     "vfile": "^6.0.3",
-    "yaml": "^2.6.1"
+    "yaml": "^2.8.2"
   },
   "devDependencies": {
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.4",
-    "@types/node": "^18.19.68",
+    "@types/node": "^22.19.15",
     "@types/unist": "^3.0.3",
-    "typescript": "^5.7.2",
-    "vitest": "2.1.6"
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
   },
   "peerDependencies": {
     "@astrojs/starlight": ">=0.34.0"
   },
   "engines": {
-    "node": ">=18.17.1"
+    "node": ">=22.12.0"
   },
-  "packageManager": "pnpm@8.14.1",
   "publishConfig": {
     "access": "public"
   },