@mdit-vue/plugin-title 0.6.0 → 0.8.0

package/README.md

@@ -18,6 +18,7 @@ npm i @mdit-vue/plugin-title
 ```ts
 import MarkdownIt from 'markdown-it';
 import { titlePlugin } from '@mdit-vue/plugin-title';
+import type { MarkdownItEnv } from '@mdit-vue/types';
 
 const md = MarkdownIt({ html: true }).use(titlePlugin);
 const env: MarkdownItEnv = {};

package/dist/index.d.ts

@@ -1,11 +1,5 @@
 import { PluginSimple } from 'markdown-it';
 
-declare module '@mdit-vue/types' {
-    interface MarkdownItEnv {
-        title?: string;
-    }
-}
-
 /**
  * Get markdown page title info
  *
@@ -13,4 +7,13 @@ declare module '@mdit-vue/types' {
  */
 declare const titlePlugin: PluginSimple;
 
+declare module '@mdit-vue/types' {
+    interface MarkdownItEnv {
+        /**
+         * The title that extracted by `@mdit-vue/plugin-title`
+         */
+        title?: string;
+    }
+}
+
 export { titlePlugin };

package/package.json

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

package/CHANGELOG.md

@@ -1,20 +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)
-
-**Note:** Version bump only for package @mdit-vue/plugin-title
-
-# [0.4.0](https://github.com/mdit-vue/mdit-vue/compare/v0.3.1...v0.4.0) (2022-07-02)
-
-### Features
-
-- **plugin-title:** add title plugin ([662e153](https://github.com/mdit-vue/mdit-vue/commit/662e153b74226df6db57531e71ab5f8d563da780))

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/index.ts

@@ -1,3 +0,0 @@
-import './types';
-
-export * from './title-plugin';

package/src/title-plugin.ts

@@ -1,35 +0,0 @@
-import { resolveTitleFromToken } from '@mdit-vue/shared';
-import type { MarkdownItEnv } from '@mdit-vue/types';
-import type { PluginSimple } from 'markdown-it';
-
-/**
- * Get markdown page title info
- *
- * Extract it to env
- */
-export const titlePlugin: PluginSimple = (md): void => {
-  let title: string;
-
-  // push the rule to the end of the chain
-  // resolve title from the parsed tokens
-  md.core.ruler.push('resolveTitle', (state) => {
-    const tokenIdx = state.tokens.findIndex((token) => token.tag === 'h1');
-    if (tokenIdx > -1) {
-      title = resolveTitleFromToken(state.tokens[tokenIdx + 1], {
-        shouldAllowHtml: false,
-        shouldEscapeText: false,
-      });
-    } else {
-      title = '';
-    }
-    return true;
-  });
-
-  // extract title to env
-  const render = md.render.bind(md);
-  md.render = (src, env: MarkdownItEnv = {}) => {
-    const result = render(src, env);
-    env.title = title;
-    return result;
-  };
-};

package/src/types.ts

@@ -1,7 +0,0 @@
-export {};
-
-declare module '@mdit-vue/types' {
-  interface MarkdownItEnv {
-    title?: string;
-  }
-}

package/tests/title-plugin.spec.ts

@@ -1,30 +0,0 @@
-import type { MarkdownItEnv } from '@mdit-vue/types';
-import MarkdownIt from 'markdown-it';
-import emojiPlugin from 'markdown-it-emoji';
-import { describe, expect, it } from 'vitest';
-import { titlePlugin } from '../src';
-
-describe('@mdit-vue/plugin-title > title-plugin', () => {
-  const md = MarkdownIt().use(emojiPlugin).use(titlePlugin);
-
-  describe('should extract title from h1 heading', () => {
-    const testCases = [
-      ['# title from h1 :tada:', 'title from h1 🎉'],
-      ['# title from h1 `foobar`', 'title from h1 foobar'],
-    ];
-
-    testCases.forEach(([source, expected]) =>
-      it(source, () => {
-        const env: MarkdownItEnv = {};
-        md.render(source, env);
-        expect(env.title).toEqual(expected);
-      }),
-    );
-  });
-
-  it('should extract empty title', () => {
-    const env: MarkdownItEnv = {};
-    md.render('', env);
-    expect(env.title).toEqual('');
-  });
-});