starlight-obsidian 0.4.9 → 0.5.0

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

@@ -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) {
@@ -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,
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-obsidian",
-  "version": "0.4.9",
+  "version": "0.5.0",
   "license": "MIT",
   "description": "Starlight plugin to publish Obsidian vaults.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",