@mdit-vue/plugin-title 0.4.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [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/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-present, mdit-vue Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,35 @@
+# @mdit-vue/plugin-title
+
+[![npm](https://badgen.net/npm/v/@mdit-vue/plugin-title)](https://www.npmjs.com/package/@mdit-vue/plugin-title)
+[![license](https://badgen.net/github/license/mdit-vue/mdit-vue)](https://github.com/mdit-vue/mdit-vue/blob/main/LICENSE)
+
+A [markdown-it](https://github.com/markdown-it/markdown-it) plugin to get page title.
+
+- Extract title (the content of the first level-1 heading) into markdown-it `env.title`.
+
+## Install
+
+```sh
+npm i @mdit-vue/plugin-title
+```
+
+## Usage
+
+```ts
+import MarkdownIt from 'markdown-it';
+import { titlePlugin } from '@mdit-vue/plugin-title';
+
+const md = MarkdownIt({ html: true }).use(titlePlugin);
+const env: MarkdownItEnv = {};
+
+const rendered = md.render(
+  `\
+# h1
+## h2
+### h3
+`,
+  env,
+);
+
+console.log(env.title);
+```

package/build.config.ts

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

package/dist/index.cjs

@@ -0,0 +1,29 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const shared = require('@mdit-vue/shared');
+
+const titlePlugin = (md) => {
+  let title;
+  md.core.ruler.push("resolveTitle", (state) => {
+    const tokenIdx = state.tokens.findIndex((token) => token.tag === "h1");
+    if (tokenIdx > -1) {
+      title = shared.resolveTitleFromToken(state.tokens[tokenIdx + 1], {
+        shouldAllowHtml: false,
+        shouldEscapeText: false
+      });
+    } else {
+      title = "";
+    }
+    return true;
+  });
+  const render = md.render.bind(md);
+  md.render = (src, env = {}) => {
+    const result = render(src, env);
+    env.title = title;
+    return result;
+  };
+};
+
+exports.titlePlugin = titlePlugin;

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import { PluginSimple } from 'markdown-it';
+
+declare module '@mdit-vue/shared' {
+    interface MarkdownItEnv {
+        title?: string;
+    }
+}
+
+/**
+ * Get markdown page title info
+ *
+ * Extract it to env
+ */
+declare const titlePlugin: PluginSimple;
+
+export { titlePlugin };

package/dist/index.mjs

@@ -0,0 +1,25 @@
+import { resolveTitleFromToken } from '@mdit-vue/shared';
+
+const titlePlugin = (md) => {
+  let title;
+  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;
+  });
+  const render = md.render.bind(md);
+  md.render = (src, env = {}) => {
+    const result = render(src, env);
+    env.title = title;
+    return result;
+  };
+};
+
+export { titlePlugin };

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@mdit-vue/plugin-title",
+  "version": "0.4.0",
+  "description": "A markdown-it plugin to get markdown page title",
+  "keywords": [
+    "markdown-it",
+    "markdown-it-plugin",
+    "vue",
+    "title"
+  ],
+  "homepage": "https://github.com/mdit-vue",
+  "bugs": {
+    "url": "https://github.com/mdit-vue/mdit-vue/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mdit-vue/mdit-vue.git"
+  },
+  "license": "MIT",
+  "author": "meteorlxy <meteor.lxy@foxmail.com>",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "unbuild",
+    "test": "vitest"
+  },
+  "dependencies": {
+    "@mdit-vue/shared": "0.4.0",
+    "@types/markdown-it": "^12.2.3",
+    "markdown-it": "^13.0.1"
+  },
+  "devDependencies": {
+    "@types/markdown-it-emoji": "^2.0.2",
+    "c8": "^7.11.3",
+    "markdown-it-emoji": "^2.0.2",
+    "unbuild": "^0.7.4",
+    "vitest": "^0.16.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "744887e6f4733af8da2045625e72a476947cfc25"
+}

package/src/index.ts

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

package/src/title-plugin.ts

@@ -0,0 +1,35 @@
+import { resolveTitleFromToken } from '@mdit-vue/shared';
+import type { MarkdownItEnv } from '@mdit-vue/shared';
+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

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

package/tests/title-plugin.spec.ts

@@ -0,0 +1,30 @@
+import type { MarkdownItEnv } from '@mdit-vue/shared';
+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('');
+  });
+});