starlight-obsidian 0.4.9 → 0.6.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# starlight-obsidian
+
+## 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

@@ -22,16 +22,24 @@ const starlightObsidianConfigSchema = z.object({
    */
   configFolder: z.string().startsWith('.').default('.obsidian'),
   /**
-   * Whether the Starlight Obsidian plugin should copy known Starlight frontmatter fields from Obsidian notes to the
-   * generated pages.
+   * Defines which frontmatter fields the Starlight Obsidian plugin should copy from Obsidian notes to the generated
+   * pages.
    *
-   * This is useful if you want to customize the generated Starlight pages from Obsidian. Note that the values are not
-   * validated and are copied as-is so it's up to you to ensure they are compatible with Starlight.
+   * By default (`none`), all unsupported properties are ignored and not exported. Set this option to `starlight` to
+   * copy all known Starlight frontmatter fields from an Obsidian note to the associated generated page or to `all` to
+   * copy all frontmatter fields.
    *
-   * @default false
+   * This option is useful if you want to customize the generated Starlight pages from Obsidian. Note that the values
+   * are not validated and are copied as-is so it's up to you to ensure they are compatible with Starlight.
+   *
+   * @default 'none'
    * @see https://starlight.astro.build/reference/frontmatter/
    */
-  copyStarlightFrontmatter: z.boolean().default(false),
+  copyFrontmatter: z.union([z.literal('none'), z.literal('starlight'), z.literal('all')]).default('none'),
+  /**
+   * @deprecated Use the {@link StarlightObsidianUserConfig.copyFrontmatter} option instead.
+   */
+  copyStarlightFrontmatter: z.never().optional(),
   /**
    * A list of glob patterns to ignore when generating the Obsidian vault pages.
    * This option can be used to ignore files or folders.
@@ -102,6 +110,17 @@ export default function starlightObsidianPlugin(userConfig: StarlightObsidianUse
   const parsedConfig = starlightObsidianConfigSchema.safeParse(userConfig)
 
   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',
+      )
+    }
+
     throwUserError(
       `The provided plugin configuration is invalid.\n${parsedConfig.error.issues.map((issue) => issue.message).join('\n')}`,
     )

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/plugin.ts

@@ -1,8 +1,9 @@
 import { AstroError } from 'astro/errors'
 
-export function throwUserError(message: string): never {
+export function throwUserError(message: string, hint?: string): never {
   throw new AstroError(
     message,
-    `See the error report above for more informations.\n\nIf you believe this is a bug, please file an issue at https://github.com/HiDeoo/starlight-obsidian/issues/new/choose`,
+    hint ??
+      `See the error report above for more informations.\n\nIf you believe this is a bug, please file an issue at https://github.com/HiDeoo/starlight-obsidian/issues/new/choose`,
   )
 }

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 ?? {}
 
@@ -453,9 +453,14 @@ function getFrontmatterNodeValue(file: VFile, obsidianFrontmatter?: ObsidianFron
     editUrl: false,
   }
 
-  if (obsidianFrontmatter && file.data.copyStarlightFrontmatter) {
-    const starlightLikeFrontmatter = getStarlightLikeFrontmatter(obsidianFrontmatter.raw)
-    frontmatter = { ...frontmatter, ...starlightLikeFrontmatter }
+  if (obsidianFrontmatter && (file.data.copyFrontmatter === 'starlight' || file.data.copyFrontmatter === 'all')) {
+    if (file.data.copyFrontmatter === 'starlight') {
+      const starlightLikeFrontmatter = getStarlightLikeFrontmatter(obsidianFrontmatter.raw)
+      frontmatter = { ...frontmatter, ...starlightLikeFrontmatter }
+    } else {
+      const { cover, image, description, permalink, tags, ...restFrontmatter } = obsidianFrontmatter.raw
+      frontmatter = { ...frontmatter, ...restFrontmatter }
+    }
   }
 
   if (file.data.includeKatexStyles) {
@@ -479,10 +484,13 @@ function getFrontmatterNodeValue(file: VFile, obsidianFrontmatter?: ObsidianFron
       frontmatter.head = []
     }
 
-    frontmatter.head.push(
-      { tag: 'meta', attrs: { property: 'og:image', content: ogImage } },
-      { tag: 'meta', attrs: { name: 'twitter:image', content: ogImage } },
-    )
+    if (!frontmatter.head.some((tag) => tag.attrs['property'] === 'og:image')) {
+      frontmatter.head.push({ tag: 'meta', attrs: { property: 'og:image', content: ogImage } })
+    }
+
+    if (!frontmatter.head.some((tag) => tag.attrs['property'] === 'twitter:image')) {
+      frontmatter.head.push({ tag: 'meta', attrs: { name: 'twitter:image', content: ogImage } })
+    }
   }
 
   if (obsidianFrontmatter?.description && obsidianFrontmatter.description.length > 0) {
@@ -558,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) {
@@ -674,7 +682,7 @@ function ensureTransformContext(file: VFile): asserts file is VFile & { data: Tr
 export interface TransformContext {
   aliases?: string[]
   assetImports?: [id: string, path: string][]
-  copyStarlightFrontmatter?: boolean
+  copyFrontmatter: StarlightObsidianConfig['copyFrontmatter']
   embedded?: boolean
   files: VaultFile[]
   includeKatexStyles?: boolean

package/libs/starlight.ts

@@ -62,6 +62,7 @@ const starlightFrontmatterKeys = [
   'prev',
   'next',
   'pagefind',
+  'draft',
   'sidebar',
 ]
 
@@ -181,7 +182,7 @@ async function addContent(
       type,
     } = await transformMarkdownToString(vaultFile.fsPath, obsidianContent, {
       files: vaultFiles,
-      copyStarlightFrontmatter: config.copyStarlightFrontmatter,
+      copyFrontmatter: config.copyFrontmatter,
       output: config.output,
       vault,
     })
@@ -279,7 +280,7 @@ function throwVaultFileError(error: unknown, vaultFile: VaultFile): never {
 }
 
 function isSidebarGroup(item: SidebarGroup): item is SidebarManualGroup {
-  return 'items' in item
+  return typeof item === 'object' && 'items' in item
 }
 
 interface OutputPaths {

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.4.9",
+  "version": "0.6.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"
   }
 }