@mdit-vue/plugin-frontmatter 3.0.0 → 3.0.2

package/dist/index.d.ts

@@ -1,50 +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 { frontmatterPlugin };
-export type { FrontmatterPluginOptions };
+//#endregion
+export { FrontmatterPluginOptions, frontmatterPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdit-vue/plugin-frontmatter",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "A markdown-it plugin to get markdown frontmatter",
   "keywords": [
     "markdown-it",
@@ -21,30 +21,28 @@
   "author": "meteorlxy <meteor.lxy@foxmail.com>",
   "type": "module",
   "exports": {
-    ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
-    },
+    ".": "./dist/index.js",
     "./package.json": "./package.json"
   },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.cts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "./dist"
   ],
   "scripts": {
     "build": "tsdown",
+    "clean": "rimraf ./dist",
     "test": "vitest"
   },
   "dependencies": {
-    "@mdit-vue/types": "3.0.0",
+    "@mdit-vue/types": "3.0.2",
     "@types/markdown-it": "^14.1.2",
     "gray-matter": "^4.0.3",
     "markdown-it": "^14.1.0"
   },
   "devDependencies": {
-    "tsdown": "^0.14.0",
+    "tsdown": "^0.14.1",
     "vitest": "^3.2.4"
   },
   "engines": {
@@ -53,5 +51,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "bbb62a47109c2932505b3f570b963f70d590914f"
+  "gitHead": "3b5332d09fbd927319bd8be3ba3b86b3d12d1ec8"
 }

package/dist/index.cjs

@@ -1,47 +0,0 @@
-//#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));
-
-//#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 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);
-	};
-};
-
-//#endregion
-exports.frontmatterPlugin = frontmatterPlugin;

package/dist/index.d.cts

@@ -1,51 +0,0 @@
-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 {
-    /**
-     * 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>;
-  }
-}
-//#endregion
-//#region src/frontmatter-plugin.d.ts
-/**
- * Get markdown frontmatter and excerpt
- *
- * Extract them into env
- */
-declare const frontmatterPlugin: PluginWithOptions<FrontmatterPluginOptions>;
-//#endregion
-export { FrontmatterPluginOptions, frontmatterPlugin };

package/dist/index.d.mts

@@ -1,51 +0,0 @@
-import grayMatter from "gray-matter";
-import { PluginWithOptions } from "markdown-it";
-
-//#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 {
-    /**
-     * 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>;
-  }
-}
-//#endregion
-//#region src/frontmatter-plugin.d.ts
-/**
- * Get markdown frontmatter and excerpt
- *
- * Extract them into env
- */
-declare const frontmatterPlugin: PluginWithOptions<FrontmatterPluginOptions>;
-//#endregion
-export { FrontmatterPluginOptions, frontmatterPlugin };