@mdit-vue/plugin-frontmatter 2.1.3 → 3.0.0

package/dist/index.cjs

@@ -1,32 +1,47 @@
-'use strict';
-
-const grayMatter = require('gray-matter');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
 
-const grayMatter__default = /*#__PURE__*/_interopDefaultCompat(grayMatter);
+//#endregion
+const gray_matter = __toESM(require("gray-matter"));
 
+//#region src/frontmatter-plugin.ts
+/**
+* Get markdown frontmatter and excerpt
+*
+* Extract them into env
+*/
 const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = true } = {}) => {
-  const render = md.render.bind(md);
-  md.render = (src, env = {}) => {
-    const { data, content, excerpt = "" } = grayMatter__default(src, grayMatterOptions);
-    env.content = content;
-    env.frontmatter = {
-      // allow providing default value
-      ...env.frontmatter,
-      ...data
-    };
-    env.excerpt = renderExcerpt && excerpt ? (
-      // render the excerpt with original markdown-it render method.
-      // here we spread `env` to avoid mutating the original object.
-      // using deep clone might be a safer choice.
-      render(excerpt, { ...env })
-    ) : (
-      // use the raw excerpt directly
-      excerpt
-    );
-    return render(content, env);
-  };
+	const parse = md.parse.bind(md);
+	md.parse = (src, env = {}) => {
+		const { data, content, excerpt = "" } = (0, gray_matter.default)(src, grayMatterOptions);
+		env.content = content;
+		env.frontmatter = {
+			...env.frontmatter,
+			...data
+		};
+		env.excerpt = renderExcerpt && excerpt ? md.render(excerpt, { ...env }) : excerpt;
+		return parse(content, env);
+	};
 };
 
-exports.frontmatterPlugin = frontmatterPlugin;
+//#endregion
+exports.frontmatterPlugin = frontmatterPlugin;

package/dist/index.d.cts

@@ -1,49 +1,51 @@
-import { PluginWithOptions } from 'markdown-it';
-import matter from 'gray-matter';
+import { PluginWithOptions } from "markdown-it";
+import matter from "gray-matter";
 
+//#region src/types.d.ts
 type GrayMatterOptions = matter.GrayMatterOption<string, GrayMatterOptions>;
 /**
  * Options of @mdit-vue/plugin-frontmatter
  */
 interface FrontmatterPluginOptions {
+  /**
+   * Options of gray-matter
+   *
+   * @see https://github.com/jonschlinkert/gray-matter#options
+   */
+  grayMatterOptions?: GrayMatterOptions;
+  /**
+   * Render the excerpt or not
+   *
+   * @default true
+   */
+  renderExcerpt?: boolean;
+}
+declare module '@mdit-vue/types' {
+  interface MarkdownItEnv {
     /**
-     * Options of gray-matter
-     *
-     * @see https://github.com/jonschlinkert/gray-matter#options
+     * The raw Markdown content without frontmatter
      */
-    grayMatterOptions?: GrayMatterOptions;
+    content?: string;
     /**
-     * Render the excerpt or not
+     * The excerpt that extracted by `@mdit-vue/plugin-frontmatter`
      *
-     * @default true
+     * - Would be the rendered HTML when `renderExcerpt` is enabled
+     * - Would be the raw Markdown when `renderExcerpt` is disabled
      */
-    renderExcerpt?: boolean;
-}
-declare module '@mdit-vue/types' {
-    interface MarkdownItEnv {
-        /**
-         * The raw Markdown content without frontmatter
-         */
-        content?: string;
-        /**
-         * The excerpt that extracted by `@mdit-vue/plugin-frontmatter`
-         *
-         * - Would be the rendered HTML when `renderExcerpt` is enabled
-         * - Would be the raw Markdown when `renderExcerpt` is disabled
-         */
-        excerpt?: string;
-        /**
-         * The frontmatter that extracted by `@mdit-vue/plugin-frontmatter`
-         */
-        frontmatter?: Record<string, unknown>;
-    }
+    excerpt?: string;
+    /**
+     * The frontmatter that extracted by `@mdit-vue/plugin-frontmatter`
+     */
+    frontmatter?: Record<string, unknown>;
+  }
 }
-
+//#endregion
+//#region src/frontmatter-plugin.d.ts
 /**
  * Get markdown frontmatter and excerpt
  *
  * Extract them into env
  */
 declare const frontmatterPlugin: PluginWithOptions<FrontmatterPluginOptions>;
-
-export { type FrontmatterPluginOptions, frontmatterPlugin };
+//#endregion
+export { FrontmatterPluginOptions, frontmatterPlugin };

package/dist/index.d.mts

@@ -1,49 +1,51 @@
-import { PluginWithOptions } from 'markdown-it';
-import matter from 'gray-matter';
+import grayMatter from "gray-matter";
+import { PluginWithOptions } from "markdown-it";
 
-type GrayMatterOptions = matter.GrayMatterOption<string, GrayMatterOptions>;
+//#region src/types.d.ts
+type GrayMatterOptions = grayMatter.GrayMatterOption<string, GrayMatterOptions>;
 /**
  * Options of @mdit-vue/plugin-frontmatter
  */
 interface FrontmatterPluginOptions {
+  /**
+   * Options of gray-matter
+   *
+   * @see https://github.com/jonschlinkert/gray-matter#options
+   */
+  grayMatterOptions?: GrayMatterOptions;
+  /**
+   * Render the excerpt or not
+   *
+   * @default true
+   */
+  renderExcerpt?: boolean;
+}
+declare module '@mdit-vue/types' {
+  interface MarkdownItEnv {
     /**
-     * Options of gray-matter
-     *
-     * @see https://github.com/jonschlinkert/gray-matter#options
+     * The raw Markdown content without frontmatter
      */
-    grayMatterOptions?: GrayMatterOptions;
+    content?: string;
     /**
-     * Render the excerpt or not
+     * The excerpt that extracted by `@mdit-vue/plugin-frontmatter`
      *
-     * @default true
+     * - Would be the rendered HTML when `renderExcerpt` is enabled
+     * - Would be the raw Markdown when `renderExcerpt` is disabled
      */
-    renderExcerpt?: boolean;
-}
-declare module '@mdit-vue/types' {
-    interface MarkdownItEnv {
-        /**
-         * The raw Markdown content without frontmatter
-         */
-        content?: string;
-        /**
-         * The excerpt that extracted by `@mdit-vue/plugin-frontmatter`
-         *
-         * - Would be the rendered HTML when `renderExcerpt` is enabled
-         * - Would be the raw Markdown when `renderExcerpt` is disabled
-         */
-        excerpt?: string;
-        /**
-         * The frontmatter that extracted by `@mdit-vue/plugin-frontmatter`
-         */
-        frontmatter?: Record<string, unknown>;
-    }
+    excerpt?: string;
+    /**
+     * The frontmatter that extracted by `@mdit-vue/plugin-frontmatter`
+     */
+    frontmatter?: Record<string, unknown>;
+  }
 }
-
+//#endregion
+//#region src/frontmatter-plugin.d.ts
 /**
  * Get markdown frontmatter and excerpt
  *
  * Extract them into env
  */
 declare const frontmatterPlugin: PluginWithOptions<FrontmatterPluginOptions>;
-
-export { type FrontmatterPluginOptions, frontmatterPlugin };
+//#endregion
+export { FrontmatterPluginOptions, frontmatterPlugin };

package/dist/index.d.ts

@@ -46,4 +46,5 @@ declare module '@mdit-vue/types' {
  */
 declare const frontmatterPlugin: PluginWithOptions<FrontmatterPluginOptions>;
 
-export { type FrontmatterPluginOptions, frontmatterPlugin };
+export { frontmatterPlugin };
+export type { FrontmatterPluginOptions };

package/dist/index.mjs

@@ -1,26 +1,24 @@
-import grayMatter from 'gray-matter';
+import grayMatter from "gray-matter";
 
+//#region src/frontmatter-plugin.ts
+/**
+* Get markdown frontmatter and excerpt
+*
+* Extract them into env
+*/
 const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = true } = {}) => {
-  const render = md.render.bind(md);
-  md.render = (src, env = {}) => {
-    const { data, content, excerpt = "" } = grayMatter(src, grayMatterOptions);
-    env.content = content;
-    env.frontmatter = {
-      // allow providing default value
-      ...env.frontmatter,
-      ...data
-    };
-    env.excerpt = renderExcerpt && excerpt ? (
-      // render the excerpt with original markdown-it render method.
-      // here we spread `env` to avoid mutating the original object.
-      // using deep clone might be a safer choice.
-      render(excerpt, { ...env })
-    ) : (
-      // use the raw excerpt directly
-      excerpt
-    );
-    return render(content, env);
-  };
+	const parse = md.parse.bind(md);
+	md.parse = (src, env = {}) => {
+		const { data, content, excerpt = "" } = grayMatter(src, grayMatterOptions);
+		env.content = content;
+		env.frontmatter = {
+			...env.frontmatter,
+			...data
+		};
+		env.excerpt = renderExcerpt && excerpt ? md.render(excerpt, { ...env }) : excerpt;
+		return parse(content, env);
+	};
 };
 
-export { frontmatterPlugin };
+//#endregion
+export { frontmatterPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdit-vue/plugin-frontmatter",
-  "version": "2.1.3",
+  "version": "3.0.0",
   "description": "A markdown-it plugin to get markdown frontmatter",
   "keywords": [
     "markdown-it",
@@ -22,34 +22,36 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    }
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
   },
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "types": "./dist/index.d.cts",
   "files": [
     "./dist"
   ],
   "scripts": {
-    "build": "unbuild",
+    "build": "tsdown",
     "test": "vitest"
   },
   "dependencies": {
-    "@mdit-vue/types": "2.1.0",
-    "@types/markdown-it": "^14.1.1",
+    "@mdit-vue/types": "3.0.0",
+    "@types/markdown-it": "^14.1.2",
     "gray-matter": "^4.0.3",
     "markdown-it": "^14.1.0"
   },
+  "devDependencies": {
+    "tsdown": "^0.14.0",
+    "vitest": "^3.2.4"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0b0ff6922bba2627dad6b9cf0e4249f0a9ecbe15"
+  "gitHead": "bbb62a47109c2932505b3f570b963f70d590914f"
 }