starlight-obsidian 0.5.0 → 0.7.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# starlight-obsidian
+
+## 0.7.0
+
+### Minor Changes
+
+- [#37](https://github.com/HiDeoo/starlight-obsidian/pull/37) [`96f7cef`](https://github.com/HiDeoo/starlight-obsidian/commit/96f7cef43c4a08923c24221fbfb95b4ef840779f) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for running [multiple instances](https://starlight-obsidian.vercel.app/guides/multiple-instances/) of the plugin for different Obsidian vaults and configurations.
+
+## 0.6.0
+
+### Minor Changes
+
+- [#34](https://github.com/HiDeoo/starlight-obsidian/pull/34) [`9079b9b`](https://github.com/HiDeoo/starlight-obsidian/commit/9079b9be67eb2efd68a3d8906068263657629974) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for Astro v5, drops support for Astro v4.
+
+  ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now `0.30.0`.
+
+  Please follow the [upgrade guide](https://github.com/withastro/starlight/releases/tag/%40astrojs/starlight%400.30.0) to update your project.

package/index.ts

@@ -1,3 +1,5 @@
+import { randomBytes } from 'node:crypto'
+
 import type { StarlightPlugin, StarlightUserConfig } from '@astrojs/starlight/types'
 import type { AstroIntegrationLogger } from 'astro'
 import { z } from 'astro/zod'
@@ -5,7 +7,7 @@ import { z } from 'astro/zod'
 import { starlightObsidianIntegration } from './libs/integration'
 import { getObsidianPaths, getVault } from './libs/obsidian'
 import { throwUserError } from './libs/plugin'
-import { addObsidianFiles, getSidebarFromConfig, getSidebarGroupPlaceholder } from './libs/starlight'
+import { addObsidianFiles, getSidebarFromConfig, getSidebarGroupPlaceholder, type SidebarGroup } from './libs/starlight'
 
 const starlightObsidianConfigSchema = z.object({
   /**
@@ -104,100 +106,119 @@ const starlightObsidianConfigSchema = z.object({
   vault: z.string(),
 })
 
+let pluginsCount = 0
+
 export const obsidianSidebarGroup = getSidebarGroupPlaceholder()
 
 export default function starlightObsidianPlugin(userConfig: StarlightObsidianUserConfig): StarlightPlugin {
-  const parsedConfig = starlightObsidianConfigSchema.safeParse(userConfig)
+  return makeStarlightObsidianPlugin(obsidianSidebarGroup)(userConfig)
+}
+
+export function createStarlightObsidianPlugin(): [plugin: typeof starlightObsidianPlugin, sidebarGroup: SidebarGroup] {
+  const sidebarGroup = getSidebarGroupPlaceholder(Symbol(randomBytes(24).toString('base64url')))
+  return [makeStarlightObsidianPlugin(sidebarGroup), sidebarGroup]
+}
+
+function makeStarlightObsidianPlugin(
+  sidebarGroup: SidebarGroup,
+): (userConfig: StarlightObsidianUserConfig) => StarlightPlugin {
+  pluginsCount++
+
+  return function starlightObsidianPlugin(userConfig) {
+    const parsedConfig = starlightObsidianConfigSchema.safeParse(userConfig)
 
-  if (!parsedConfig.success) {
-    const isUsingDeprecatedCopyStarlightFrontmatter = parsedConfig.error.issues.some(
-      (issue) => issue.path.join('.') === 'copyStarlightFrontmatter',
-    )
+    if (!parsedConfig.success) {
+      const isUsingDeprecatedCopyStarlightFrontmatter = parsedConfig.error.issues.some(
+        (issue) => issue.path.join('.') === 'copyStarlightFrontmatter',
+      )
+
+      if (isUsingDeprecatedCopyStarlightFrontmatter) {
+        throwUserError(
+          'The `copyStarlightFrontmatter` option has been deprecated in favor of the `copyFrontmatter` option.',
+          'For more information see https://starlight-obsidian.vercel.app/configuration/#copyfrontmatter',
+        )
+      }
 
-    if (isUsingDeprecatedCopyStarlightFrontmatter) {
       throwUserError(
-        'The `copyStarlightFrontmatter` option has been deprecated in favor of the `copyFrontmatter` option.',
-        'For more information see https://starlight-obsidian.vercel.app/configuration/#copyfrontmatter',
+        `The provided plugin configuration is invalid.\n${parsedConfig.error.issues.map((issue) => issue.message).join('\n')}`,
       )
     }
 
-    throwUserError(
-      `The provided plugin configuration is invalid.\n${parsedConfig.error.issues.map((issue) => issue.message).join('\n')}`,
-    )
-  }
+    const config = parsedConfig.data
+
+    return {
+      name: 'starlight-obsidian-plugin',
+      hooks: {
+        async setup({ addIntegration, command, config: starlightConfig, logger, updateConfig }) {
+          if (command !== 'build' && command !== 'dev') {
+            return
+          }
+
+          const customCss = [...(starlightConfig.customCss ?? []), 'starlight-obsidian/styles/common']
+
+          if (config.autoLinkHeadings) {
+            customCss.push('starlight-obsidian/styles/autolinks-headings')
+          }
+
+          const updatedStarlightConfig: Partial<StarlightUserConfig> = {
+            components: starlightConfig.components,
+            customCss,
+            sidebar: getSidebarFromConfig(config, starlightConfig.sidebar, sidebarGroup),
+          }
 
-  const config = parsedConfig.data
-
-  return {
-    name: 'starlight-obsidian-plugin',
-    hooks: {
-      async setup({ addIntegration, command, config: starlightConfig, logger, updateConfig }) {
-        if (command !== 'build' && command !== 'dev') {
-          return
-        }
-
-        const customCss = [...(starlightConfig.customCss ?? []), 'starlight-obsidian/styles/common']
-
-        if (config.autoLinkHeadings) {
-          customCss.push('starlight-obsidian/styles/autolinks-headings')
-        }
-
-        const updatedStarlightConfig: Partial<StarlightUserConfig> = {
-          components: starlightConfig.components,
-          customCss,
-          sidebar: getSidebarFromConfig(config, starlightConfig.sidebar),
-        }
-
-        if (!updatedStarlightConfig.components) {
-          updatedStarlightConfig.components = {}
-        }
-
-        if (starlightConfig.components?.PageTitle) {
-          logComponentOverrideWarning(logger, 'PageTitle')
-        } else {
-          updatedStarlightConfig.components.PageTitle = 'starlight-obsidian/overrides/PageTitle.astro'
-        }
-
-        if (config.tableOfContentsOverview === 'title') {
-          if (starlightConfig.components?.PageSidebar) {
-            logComponentOverrideWarning(logger, 'PageSidebar')
+          if (!updatedStarlightConfig.components) {
+            updatedStarlightConfig.components = {}
+          }
+
+          if (starlightConfig.components?.PageTitle) {
+            logComponentOverrideWarning(logger, 'PageTitle')
           } else {
-            updatedStarlightConfig.components.PageSidebar = 'starlight-obsidian/overrides/PageSidebar.astro'
+            updatedStarlightConfig.components.PageTitle = 'starlight-obsidian/overrides/PageTitle.astro'
+          }
+
+          if (config.tableOfContentsOverview === 'title') {
+            if (starlightConfig.components?.PageSidebar) {
+              logComponentOverrideWarning(logger, 'PageSidebar')
+            } else {
+              updatedStarlightConfig.components.PageSidebar = 'starlight-obsidian/overrides/PageSidebar.astro'
+            }
           }
-        }
-
-        if (config.skipGeneration) {
-          logger.warn(
-            `Skipping generation of Starlight pages from Obsidian vault as the 'skipGeneration' option is enabled.`,
-          )
-        } else {
-          try {
-            const start = performance.now()
-            logger.info('Generating Starlight pages from Obsidian vault…')
-
-            const vault = await getVault(config)
-            const obsidianPaths = await getObsidianPaths(vault, config.ignore)
-            await addObsidianFiles(config, vault, obsidianPaths, logger)
-
-            const duration = Math.round(performance.now() - start)
-            logger.info(`Starlight pages generated from Obsidian vault in ${duration}ms.`)
-          } catch (error) {
-            logger.error(error instanceof Error ? error.message : String(error))
-
-            throwUserError('Failed to generate Starlight pages from Obsidian vault.')
+
+          if (config.skipGeneration) {
+            logger.warn(
+              `Skipping generation of Starlight pages from Obsidian vault as the 'skipGeneration' option is enabled.`,
+            )
+          } else {
+            try {
+              const start = performance.now()
+              logger.info(`Generating Starlight pages from Obsidian vault at '${config.vault}'…`)
+
+              const vault = await getVault(config)
+              const obsidianPaths = await getObsidianPaths(vault, config.ignore)
+              await addObsidianFiles(config, vault, obsidianPaths, logger)
+
+              const duration = Math.round(performance.now() - start)
+              logger.info(`Starlight pages generated from Obsidian vault at '${config.vault}' in ${duration}ms.`)
+            } catch (error) {
+              logger.error(error instanceof Error ? error.message : String(error))
+
+              throwUserError(`Failed to generate Starlight pages from Obsidian vault at '${config.vault}'.`)
+            }
           }
-        }
 
-        addIntegration(starlightObsidianIntegration(config))
-        updateConfig(updatedStarlightConfig)
+          addIntegration(starlightObsidianIntegration(config))
+          updateConfig(updatedStarlightConfig)
+        },
       },
-    },
+    }
   }
 }
 
 function logComponentOverrideWarning(logger: AstroIntegrationLogger, component: string) {
-  logger.warn(`It looks like you already have a \`${component}\` component override in your Starlight configuration.`)
-  logger.warn(`To use \`starlight-obsidian\`, remove the override for the \`${component}\` component.\n`)
+  if (pluginsCount < 2) {
+    logger.warn(`It looks like you already have a \`${component}\` component override in your Starlight configuration.`)
+    logger.warn(`To use \`starlight-obsidian\`, remove the override for the \`${component}\` component.\n`)
+  }
 }
 
 export type StarlightObsidianUserConfig = z.input<typeof starlightObsidianConfigSchema>

package/libs/obsidian.ts

@@ -224,8 +224,8 @@ interface BaseVaultFile {
 }
 
 export interface VaultFile extends BaseVaultFile {
-  isEqualFileName(otherFileName: string): boolean
-  isEqualStem(otherStem: string): boolean
+  isEqualFileName: (otherFileName: string) => boolean
+  isEqualStem: (otherStem: string) => boolean
 }
 
 export type ObsidianFrontmatter = z.output<typeof obsidianFrontmatterSchema> & {

package/libs/rehype.ts

@@ -82,7 +82,7 @@ function isNodeWithValue(node: ElementContent | undefined): node is NodeWithValu
 }
 
 function getBlockIdentifer(node: NodeWithValue): { length: number; name: string } | undefined {
-  const match = node.value.match(blockIdentifierRegex)
+  const match = blockIdentifierRegex.exec(node.value)
   const identifier = match?.groups?.['identifier']
   const name = match?.groups?.['name']
 

package/libs/remark.ts

@@ -377,7 +377,7 @@ function handleBlockquotes(node: Blockquote, context: VisitorContext) {
     return SKIP
   }
 
-  const match = firstLine.match(calloutRegex)
+  const match = calloutRegex.exec(firstLine)
 
   const { title, type } = match?.groups ?? {}
 
@@ -566,7 +566,7 @@ function handleImagesWithSize(node: Image, context: VisitorContext, type: 'asset
     return
   }
 
-  const match = node.alt.match(imageSizeRegex)
+  const match = imageSizeRegex.exec(node.alt)
   const { altText, width, widthOnly, height } = match?.groups ?? {}
 
   if (widthOnly === undefined && width === undefined) {

package/libs/starlight.ts

@@ -66,23 +66,24 @@ const starlightFrontmatterKeys = [
   'sidebar',
 ]
 
-export function getSidebarGroupPlaceholder(): SidebarManualGroup {
+export function getSidebarGroupPlaceholder(label = starlightObsidianSidebarGroupLabel): SidebarManualGroup {
   return {
     items: [],
-    label: starlightObsidianSidebarGroupLabel.toString(),
+    label: label.toString(),
   }
 }
 
 export function getSidebarFromConfig(
   config: StarlightObsidianConfig,
   sidebar: StarlightUserConfig['sidebar'],
+  sidebarGroupPlaceholder: SidebarGroup,
 ): StarlightUserConfig['sidebar'] {
   if (!sidebar || sidebar.length === 0) {
     return sidebar
   }
 
-  function replaceSidebarGroupPlaceholder(group: SidebarManualGroup): SidebarGroup {
-    if (group.label === starlightObsidianSidebarGroupLabel.toString()) {
+  function replaceSidebarGroupPlaceholder(group: SidebarManualGroup): SidebarItem {
+    if (group.label === sidebarGroupPlaceholder.label) {
       return {
         autogenerate: {
           collapsed: config.sidebar.collapsedFolders ?? config.sidebar.collapsed,
@@ -279,8 +280,8 @@ function throwVaultFileError(error: unknown, vaultFile: VaultFile): never {
   throw new Error(`${vaultFile.path} — ${error instanceof Error ? error.message : String(error)}`, { cause: error })
 }
 
-function isSidebarGroup(item: SidebarGroup): item is SidebarManualGroup {
-  return 'items' in item
+function isSidebarGroup(item: SidebarItem): item is SidebarManualGroup {
+  return typeof item === 'object' && 'items' in item
 }
 
 interface OutputPaths {
@@ -294,4 +295,5 @@ interface SidebarManualGroup {
   label: string
 }
 
-type SidebarGroup = NonNullable<StarlightUserConfig['sidebar']>[number]
+type SidebarItem = NonNullable<StarlightUserConfig['sidebar']>[number]
+export type SidebarGroup = Exclude<SidebarItem, string>

package/overrides/PageTitle.astro

@@ -6,6 +6,7 @@ import Tags from '../components/Tags.astro'
 
 const { entry } = Astro.props
 
+// @ts-expect-error - This plugin does not extend Starlight's schema so tags are unknown.
 const tags = entry['data']['tags']
 const showTags = tags !== undefined && tags.length > 0
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-obsidian",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "license": "MIT",
   "description": "Starlight plugin to publish Obsidian vaults.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -17,53 +17,52 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@astro-community/astro-embed-twitter": "0.5.3",
-    "@astro-community/astro-embed-youtube": "0.4.4",
-    "@astrojs/markdown-remark": "4.2.1",
-    "decode-uri-component": "0.4.1",
-    "github-slugger": "2.0.0",
-    "globby": "14.0.0",
-    "hast-util-to-html": "9.0.0",
-    "hast-util-to-string": "3.0.0",
-    "hastscript": "9.0.0",
-    "html-escaper": "3.0.3",
-    "is-absolute-url": "4.0.1",
-    "mdast-util-find-and-replace": "3.0.1",
-    "mdast-util-from-markdown": "2.0.0",
-    "mdast-util-to-hast": "13.1.0",
-    "nanoid": "5.0.4",
-    "rehype": "13.0.1",
-    "rehype-autolink-headings": "7.1.0",
-    "rehype-katex": "7.0.0",
-    "rehype-mermaid": "2.1.0",
-    "remark": "15.0.1",
-    "remark-frontmatter": "5.0.0",
-    "remark-gfm": "4.0.0",
-    "remark-math": "6.0.0",
-    "unist-util-visit": "5.0.0",
-    "vfile": "6.0.1",
-    "yaml": "2.3.4"
+    "@astro-community/astro-embed-twitter": "^0.5.8",
+    "@astro-community/astro-embed-youtube": "^0.5.6",
+    "@astrojs/markdown-remark": "^6.0.0",
+    "decode-uri-component": "^0.4.1",
+    "github-slugger": "^2.0.0",
+    "globby": "^14.0.2",
+    "hast-util-to-html": "^9.0.4",
+    "hast-util-to-string": "^3.0.1",
+    "hastscript": "^9.0.0",
+    "html-escaper": "^3.0.3",
+    "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",
+    "rehype": "^13.0.2",
+    "rehype-autolink-headings": "^7.1.0",
+    "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-math": "^6.0.0",
+    "unist-util-visit": "^5.0.0",
+    "vfile": "^6.0.3",
+    "yaml": "^2.6.1"
   },
   "devDependencies": {
-    "@astrojs/starlight": "0.24.4",
-    "@types/hast": "3.0.3",
-    "@types/html-escaper": "3.0.2",
-    "@types/mdast": "4.0.3",
-    "@types/unist": "3.0.2",
-    "astro": "4.11.1",
-    "typescript": "5.3.3",
-    "vitest": "1.2.1"
+    "@types/hast": "^3.0.4",
+    "@types/html-escaper": "^3.0.2",
+    "@types/mdast": "^4.0.4",
+    "@types/node": "^18.19.68",
+    "@types/unist": "^3.0.3",
+    "typescript": "^5.7.2",
+    "vitest": "2.1.6"
   },
   "peerDependencies": {
-    "@astrojs/starlight": ">=0.15.0",
-    "astro": ">=4.0.0"
+    "@astrojs/starlight": ">=0.30.0"
   },
   "engines": {
-    "node": ">=18.14.1"
+    "node": ">=18.17.1"
   },
   "packageManager": "pnpm@8.14.1",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "sideEffects": false,
   "keywords": [
@@ -77,11 +76,12 @@
   "homepage": "https://github.com/HiDeoo/starlight-obsidian",
   "repository": {
     "type": "git",
-    "url": "https://github.com/HiDeoo/starlight-obsidian.git"
+    "url": "https://github.com/HiDeoo/starlight-obsidian.git",
+    "directory": "packages/starlight-obsidian"
   },
   "bugs": "https://github.com/HiDeoo/starlight-obsidian/issues",
   "scripts": {
     "test": "vitest",
-    "lint": "prettier -c --cache . && eslint . --cache --max-warnings=0"
+    "lint": "eslint . --cache --max-warnings=0"
   }
 }