@mdit-vue/plugin-frontmatter 2.1.4 → 3.0.1

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/dist/index.js

@@ -0,0 +1,24 @@
+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 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);
+	};
+};
+
+//#endregion
+export { frontmatterPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdit-vue/plugin-frontmatter",
-  "version": "2.1.4",
+  "version": "3.0.1",
   "description": "A markdown-it plugin to get markdown frontmatter",
   "keywords": [
     "markdown-it",
@@ -21,35 +21,34 @@
   "author": "meteorlxy <meteor.lxy@foxmail.com>",
   "type": "module",
   "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    }
-  },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "./dist"
   ],
   "scripts": {
-    "build": "unbuild",
+    "build": "tsdown",
     "test": "vitest"
   },
   "dependencies": {
-    "@mdit-vue/types": "2.1.4",
+    "@mdit-vue/types": "3.0.1",
     "@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": "01a6daa37fff48ea3992becfd4ba8c0f97a605ad"
+  "gitHead": "cdffe386ef7b897f1bf878ce20e38bdd07908fb1"
 }

package/dist/index.cjs

@@ -1,32 +0,0 @@
-'use strict';
-
-const grayMatter = require('gray-matter');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
-
-const grayMatter__default = /*#__PURE__*/_interopDefaultCompat(grayMatter);
-
-const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = true } = {}) => {
-  const parse = md.parse.bind(md);
-  md.parse = (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.
-      md.render(excerpt, { ...env })
-    ) : (
-      // use the raw excerpt directly
-      excerpt
-    );
-    return parse(content, env);
-  };
-};
-
-exports.frontmatterPlugin = frontmatterPlugin;

package/dist/index.d.cts

@@ -1,50 +0,0 @@
-import { PluginWithOptions } from 'markdown-it';
-import matter from 'gray-matter';
-
-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>;
-    }
-}
-
-/**
- * Get markdown frontmatter and excerpt
- *
- * Extract them into env
- */
-declare const frontmatterPlugin: PluginWithOptions<FrontmatterPluginOptions>;
-
-export { frontmatterPlugin };
-export type { FrontmatterPluginOptions };

package/dist/index.d.mts

@@ -1,50 +0,0 @@
-import { PluginWithOptions } from 'markdown-it';
-import matter from 'gray-matter';
-
-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>;
-    }
-}
-
-/**
- * Get markdown frontmatter and excerpt
- *
- * Extract them into env
- */
-declare const frontmatterPlugin: PluginWithOptions<FrontmatterPluginOptions>;
-
-export { frontmatterPlugin };
-export type { FrontmatterPluginOptions };

package/dist/index.mjs

@@ -1,26 +0,0 @@
-import grayMatter from 'gray-matter';
-
-const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = true } = {}) => {
-  const parse = md.parse.bind(md);
-  md.parse = (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.
-      md.render(excerpt, { ...env })
-    ) : (
-      // use the raw excerpt directly
-      excerpt
-    );
-    return parse(content, env);
-  };
-};
-
-export { frontmatterPlugin };