feat!: move grayMatterOptions under frontmatterOptions (#8)

Author: meteorlxy

src/markdown.ts

@@ -51,10 +51,10 @@ export function createMarkdown(options: ResolvedOptions) {
 
   if (options.frontmatter || options.excerpt) {
     markdown.use(frontmatterPlugin, {
-      renderExcerpt: false,
+      ...options.frontmatterOptions,
       grayMatterOptions: {
         excerpt: options.excerpt,
-        ...options.grayMatterOptions,
+        ...options.frontmatterOptions.grayMatterOptions,
       },
     })
   }

src/options.ts

@@ -8,22 +8,22 @@ export function resolveOptions(userOptions: Options): ResolvedOptions {
     headEnabled: false,
     headField: '',
     frontmatter: true,
-    include: null,
-    exclude: null,
     excerpt: false,
     exposeFrontmatter: true,
     exposeExcerpt: false,
     escapeCodeTagInterpolation: true,
     customSfcBlocks: ['route', 'i18n', 'style'],
     componentOptions: {},
+    frontmatterOptions: {},
     markdownItOptions: {},
     markdownItUses: [],
     markdownItSetup: () => {},
-    grayMatterOptions: {},
     wrapperComponent: null,
     transforms: {},
     vueVersion: userOptions.vueVersion || getVueVersion(),
     wrapperClasses: 'markdown-body',
+    include: null,
+    exclude: null,
   }
   const options = userOptions.frontmatterPreprocess
     ? { ...defaultOptions, ...userOptions }

src/types.ts

@@ -91,6 +91,11 @@ export interface Options {
    */
   componentOptions?: ComponentPluginOptions
 
+  /**
+   * Options passed to [@mdit-vue/plugin-frontmatter](https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-frontmatter)
+   */
+  frontmatterOptions?: FrontmatterPluginOptions
+
   /**
    * Custom function to provide defaults to the frontmatter and
    * move certain attributes into the "meta" category.
@@ -149,11 +154,6 @@ export interface Options {
    */
   markdownItSetup?: (MarkdownIt: MarkdownIt) => void
 
-  /**
-   * Options passed to [gray-matter](https://github.com/jonschlinkert/gray-matter#options)
-   */
-  grayMatterOptions?: FrontmatterPluginOptions['grayMatterOptions']
-
   /**
    * Class names for wrapper div
    *

test/__snapshots__/excerpt.test.ts.snap

@@ -1,7 +1,7 @@
 // Vitest Snapshot v1
 
-exports[`excerpt > basic-excerpt 1`] = `
-"<template><div class=\\"markdown-body\\"><p>This is an excerpt.</p>
+exports[`excerpt > raw excerpt 1`] = `
+"<template><div class=\\"markdown-body\\"><p>This is an excerpt which is kept as <strong>raw Markdown</strong>.</p>
 <!-- more -->
 <h1>Hello</h1>
 <ul>
@@ -13,10 +13,31 @@ exports[`excerpt > basic-excerpt 1`] = `
 <script setup>
 const frontmatter = {\\"title\\":\\"Hey\\"}
 defineExpose({ frontmatter })
-const excerpt = \\"\\\\nThis is an excerpt.\\\\n\\\\n\\"
+const excerpt = \\"\\\\nThis is an excerpt which is kept as **raw Markdown**.\\\\n\\\\n\\"
 </script>
 <script>
 export const title = \\"Hey\\"
-export const excerpt = \\"\\\\nThis is an excerpt.\\\\n\\\\n\\"
+export const excerpt = \\"\\\\nThis is an excerpt which is kept as **raw Markdown**.\\\\n\\\\n\\"
+</script>"
+`;
+
+exports[`excerpt > rendered excerpt 1`] = `
+"<template><div class=\\"markdown-body\\"><p>This is an excerpt which has been rendered to <strong>HTML</strong>.</p>
+<!-- more -->
+<h1>Hello</h1>
+<ul>
+<li>A</li>
+<li>B</li>
+<li>C</li>
+</ul>
+</div></template>
+<script setup>
+const frontmatter = {\\"title\\":\\"Hey\\"}
+defineExpose({ frontmatter })
+const excerpt = \\"<p>This is an excerpt which has been rendered to <strong>HTML</strong>.</p>\\\\n\\"
+</script>
+<script>
+export const title = \\"Hey\\"
+export const excerpt = \\"<p>This is an excerpt which has been rendered to <strong>HTML</strong>.</p>\\\\n\\"
 </script>"
 `;

test/excerpt.test.ts

@@ -3,21 +3,50 @@ import { createMarkdown } from '../src/markdown'
 import { resolveOptions } from '../src/options'
 
 describe('excerpt', () => {
-  const options = resolveOptions({
-    excerpt: true,
-    grayMatterOptions: {
+  it('rendered excerpt', () => {
+    const options = resolveOptions({
       excerpt: true,
-      excerpt_separator: '<!-- more -->',
-    },
+      frontmatterOptions: {
+        grayMatterOptions: {
+          excerpt: true,
+          excerpt_separator: '<!-- more -->',
+        },
+      },
+    })
+    const markdownToVue = createMarkdown(options)
+    const md = `---
+title: Hey
+---
+
+This is an excerpt which has been rendered to **HTML**.
+
+<!-- more -->
+
+# Hello
+
+- A
+- B
+- C`
+    expect(markdownToVue('', md)).toMatchSnapshot()
   })
-  const markdownToVue = createMarkdown(options)
 
-  it('basic-excerpt', () => {
+  it('raw excerpt', () => {
+    const options = resolveOptions({
+      excerpt: true,
+      frontmatterOptions: {
+        renderExcerpt: false,
+        grayMatterOptions: {
+          excerpt: true,
+          excerpt_separator: '<!-- more -->',
+        },
+      },
+    })
+    const markdownToVue = createMarkdown(options)
     const md = `---
 title: Hey
 ---
 
-This is an excerpt.
+This is an excerpt which is kept as **raw Markdown**.
 
 <!-- more -->