@mdit-vue/plugin-frontmatter 0.6.0 → 0.8.0

package/README.md

@@ -7,6 +7,7 @@ A [markdown-it](https://github.com/markdown-it/markdown-it) plugin to get markdo
 
 - Extract frontmatter into markdown-it `env.frontmatter`.
 - Allow providing default frontmatter via markdown-it `env.frontmatter`.
+- Extract markdown content without frontmatter into markdown-it `env.content`.
 - Support extracting rendered excerpt into markdown-it `env.excerpt`.
 
 ## Install
@@ -20,6 +21,7 @@ npm i @mdit-vue/plugin-frontmatter
 ```ts
 import MarkdownIt from 'markdown-it';
 import { frontmatterPlugin } from '@mdit-vue/plugin-frontmatter';
+import type { MarkdownItEnv } from '@mdit-vue/types';
 
 const md = MarkdownIt({ html: true }).use(frontmatterPlugin, {
   // options

package/dist/index.cjs

@@ -12,6 +12,7 @@ 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 = {
       ...env.frontmatter,
       ...data

package/dist/index.d.ts

@@ -14,12 +14,27 @@ interface FrontmatterPluginOptions {
     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>;
     }
 }

package/dist/index.mjs

@@ -4,6 +4,7 @@ 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 = {
       ...env.frontmatter,
       ...data

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdit-vue/plugin-frontmatter",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "A markdown-it plugin to get markdown frontmatter",
   "keywords": [
     "markdown-it",
@@ -19,6 +19,7 @@
   },
   "license": "MIT",
   "author": "meteorlxy <meteor.lxy@foxmail.com>",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -29,23 +30,26 @@
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
+  "files": [
+    "./dist"
+  ],
   "scripts": {
     "build": "unbuild",
     "test": "vitest"
   },
   "dependencies": {
-    "@mdit-vue/types": "0.6.0",
+    "@mdit-vue/types": "0.8.0",
     "@types/markdown-it": "^12.2.3",
     "gray-matter": "^4.0.3",
     "markdown-it": "^13.0.1"
   },
   "devDependencies": {
-    "c8": "^7.11.3",
-    "unbuild": "^0.7.4",
-    "vitest": "^0.18.0"
+    "c8": "^7.12.0",
+    "unbuild": "^0.7.6",
+    "vitest": "^0.18.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "654a3a4d52f4fb9711bf5f7ba3674ff58ec663bf"
+  "gitHead": "7fd357a18b8bcc347cf17e2e78da3b3ed4242e58"
 }

package/CHANGELOG.md

@@ -1,16 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [0.6.0](https://github.com/mdit-vue/mdit-vue/compare/v0.5.0...v0.6.0) (2022-07-11)
-
-### Features
-
-- **types:** extract types from shared package ([5fc56ce](https://github.com/mdit-vue/mdit-vue/commit/5fc56ce6439159584e09e13ca9a6e87abe8f4389))
-
-# [0.5.0](https://github.com/mdit-vue/mdit-vue/compare/v0.4.0...v0.5.0) (2022-07-06)
-
-### Features
-
-- **plugin-frontmatter:** add frontmatter plugin ([bcffc7a](https://github.com/mdit-vue/mdit-vue/commit/bcffc7a7fef0c48a869d703f0358d168524ac19e))

package/build.config.ts

@@ -1,11 +0,0 @@
-import { defineBuildConfig } from 'unbuild';
-
-export default defineBuildConfig({
-  clean: true,
-  declaration: true,
-  entries: ['src/index'],
-  rollup: {
-    emitCJS: true,
-    inlineDependencies: false,
-  },
-});

package/src/frontmatter-plugin.ts

@@ -1,38 +0,0 @@
-import type { MarkdownItEnv } from '@mdit-vue/types';
-import grayMatter from 'gray-matter';
-import type { PluginWithOptions } from 'markdown-it';
-import type { FrontmatterPluginOptions } from './types';
-
-/**
- * Get markdown frontmatter and excerpt
- *
- * Extract them to env
- */
-export const frontmatterPlugin: PluginWithOptions<FrontmatterPluginOptions> = (
-  md,
-  { grayMatterOptions, renderExcerpt = true } = {},
-): void => {
-  const render = md.render.bind(md);
-  md.render = (src, env: MarkdownItEnv = {}) => {
-    const { data, content, excerpt = '' } = grayMatter(src, grayMatterOptions);
-
-    // extract frontmatter
-    env.frontmatter = {
-      // allow providing default value
-      ...env.frontmatter,
-      ...data,
-    };
-
-    // render and extract excerpt
-    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);
-  };
-};

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './frontmatter-plugin';
-export * from './types';

package/src/types.ts

@@ -1,27 +0,0 @@
-import type { GrayMatterOption } from 'gray-matter';
-
-type GrayMatterOptions = GrayMatterOption<string, GrayMatterOptions>;
-
-/**
- * Options of @mdit-vue/plugin-frontmatter
- */
-export interface FrontmatterPluginOptions {
-  /**
-   * Options of gray-matter
-   *
-   * @see https://github.com/jonschlinkert/gray-matter#options
-   */
-  grayMatterOptions?: GrayMatterOptions;
-
-  /**
-   * Render the excerpt or not
-   */
-  renderExcerpt?: boolean;
-}
-
-declare module '@mdit-vue/types' {
-  interface MarkdownItEnv {
-    excerpt?: string;
-    frontmatter?: Record<string, unknown>;
-  }
-}

package/tests/frontmatter-plugin.spec.ts

@@ -1,143 +0,0 @@
-import type { MarkdownItEnv } from '@mdit-vue/types';
-import MarkdownIt from 'markdown-it';
-import { describe, expect, it } from 'vitest';
-import { frontmatterPlugin } from '../src';
-import type { FrontmatterPluginOptions } from '../src';
-
-const testCases: {
-  source: string;
-  options: FrontmatterPluginOptions;
-  env: MarkdownItEnv;
-  frontmatter: MarkdownItEnv['frontmatter'];
-  excerpt: MarkdownItEnv['excerpt'];
-}[] = [
-  {
-    source: `\
----
-str: string
-num: 123
-date: 2022-07-06
----
-`,
-    options: {},
-    env: {},
-    frontmatter: {
-      str: 'string',
-      num: 123,
-      date: new Date('2022-07-06T00:00:00Z'),
-    },
-    excerpt: '',
-  },
-  {
-    source: `\
----
-foo: foo
-bar: bar
----
-`,
-    options: {},
-    env: {
-      frontmatter: {
-        foo: 'default-foo',
-        baz: 'default-baz',
-      },
-    },
-    frontmatter: {
-      foo: 'foo',
-      bar: 'bar',
-      baz: 'default-baz',
-    },
-    excerpt: '',
-  },
-  {
-    source: `\
-# Hello, world
----
-`,
-    options: {},
-    env: {},
-    frontmatter: {},
-    excerpt: '',
-  },
-  {
-    source: `\
----
-foo: foo
-bar: bar
----
-# Hello, world
----
-`,
-    options: {
-      grayMatterOptions: {
-        excerpt: true,
-      },
-      renderExcerpt: true,
-    },
-    env: {},
-    frontmatter: {
-      foo: 'foo',
-      bar: 'bar',
-    },
-    excerpt: '<h1>Hello, world</h1>\n',
-  },
-  {
-    source: `\
----
-foo: foo
-bar: bar
----
-# Hello, world
-<!-- more -->
-`,
-    options: {
-      grayMatterOptions: {
-        excerpt: true,
-        excerpt_separator: '<!-- more -->',
-      },
-      renderExcerpt: true,
-    },
-    env: {},
-    frontmatter: {
-      foo: 'foo',
-      bar: 'bar',
-    },
-    excerpt: '<h1>Hello, world</h1>\n',
-  },
-  {
-    source: `\
----
-foo: foo
-bar: bar
----
-# Hello, world
-<!-- more -->
-`,
-    options: {
-      grayMatterOptions: {
-        excerpt: true,
-        excerpt_separator: '<!-- more -->',
-      },
-      renderExcerpt: false,
-    },
-    env: {},
-    frontmatter: {
-      foo: 'foo',
-      bar: 'bar',
-    },
-    excerpt: '# Hello, world\n',
-  },
-];
-
-describe('@mdit-vue/plugin-frontmatter > frontmatter-plugin', () => {
-  testCases.forEach(
-    ({ source, options, env: rawEnv, frontmatter, excerpt }, i) =>
-      it(`case ${i}`, () => {
-        const md = MarkdownIt().use(frontmatterPlugin, options);
-        const env: MarkdownItEnv = { ...rawEnv };
-        md.render(source, env);
-        expect(env.frontmatter).toEqual(frontmatter);
-        expect(env.excerpt).toEqual(excerpt);
-      }),
-  );
-});