@mdit-vue/shared 0.6.0 → 0.8.0

package/dist/index.cjs

@@ -27,10 +27,7 @@ const htmlUnescapeMap = {
 const htmlUnescapeRegexp = /&(amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
 const htmlUnescape = (str) => str.replace(htmlUnescapeRegexp, (char) => htmlUnescapeMap[char]);
 
-const resolveTitleFromToken = (token, {
-  shouldAllowHtml,
-  shouldEscapeText
-}) => {
+const resolveTitleFromToken = (token, { shouldAllowHtml, shouldEscapeText }) => {
   const children = token.children ?? [];
   const titleTokenTypes = ["text", "emoji", "code_inline"];
   if (shouldAllowHtml) {

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { MarkdownItHeader } from '@mdit-vue/types';
-import Token from 'markdown-it/lib/token';
+import Token from 'markdown-it/lib/token.js';
 
 /**
  * Escape html chars
@@ -11,30 +11,53 @@ declare const htmlEscape: (str: string) => string;
  */
 declare const htmlUnescape: (str: string) => string;
 
-/**
- * Resolve headers from markdown-it tokens
- */
-declare const resolveHeadersFromTokens: (tokens: Token[], { level, shouldAllowHtml, shouldEscapeText, slugify, format, }: {
-    level: number[];
+interface ResolveTitleOptions {
+    /**
+     * Should allow inline HTML tags or not.
+     *
+     * If the result is going to be used as Vue template, it should allow inline
+     * HTML tags so that Vue custom components would be kept.
+     */
     shouldAllowHtml: boolean;
+    /**
+     * Should escape the text content or not.
+     *
+     * If the result is going to be used in HTML directly, it should be escaped
+     * so that the text content won't be wrongly treated as HTML tags.
+     */
     shouldEscapeText: boolean;
-    slugify: (str: string) => string;
-    format?: ((str: string) => string) | undefined;
-}) => MarkdownItHeader[];
-
+}
 /**
  * Resolve header title from markdown-it token
  *
  * Typically using the next token of `heading_open` token
  */
-declare const resolveTitleFromToken: (token: Token, { shouldAllowHtml, shouldEscapeText, }: {
-    shouldAllowHtml: boolean;
-    shouldEscapeText: boolean;
-}) => string;
+declare const resolveTitleFromToken: (token: Token, { shouldAllowHtml, shouldEscapeText }: ResolveTitleOptions) => string;
+
+interface ResolveHeadersOptions extends ResolveTitleOptions {
+    /**
+     * Heading level that going to be resolved
+     */
+    level: number[];
+    /**
+     * A custom slugification function
+     *
+     * Would be ignored if the `id` attr of the token is set.
+     */
+    slugify: (str: string) => string;
+    /**
+     * A function for formatting headings
+     */
+    format?: (str: string) => string;
+}
+/**
+ * Resolve headers from markdown-it tokens
+ */
+declare const resolveHeadersFromTokens: (tokens: Token[], { level, shouldAllowHtml, shouldEscapeText, slugify, format, }: ResolveHeadersOptions) => MarkdownItHeader[];
 
 /**
  * Default slugification function
  */
 declare const slugify: (str: string) => string;
 
-export { htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify };
+export { ResolveHeadersOptions, ResolveTitleOptions, htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify };

package/dist/index.mjs

@@ -23,10 +23,7 @@ const htmlUnescapeMap = {
 const htmlUnescapeRegexp = /&(amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
 const htmlUnescape = (str) => str.replace(htmlUnescapeRegexp, (char) => htmlUnescapeMap[char]);
 
-const resolveTitleFromToken = (token, {
-  shouldAllowHtml,
-  shouldEscapeText
-}) => {
+const resolveTitleFromToken = (token, { shouldAllowHtml, shouldEscapeText }) => {
   const children = token.children ?? [];
   const titleTokenTypes = ["text", "emoji", "code_inline"];
   if (shouldAllowHtml) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdit-vue/shared",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Shared utils and types of mdit-vue",
   "keywords": [
     "markdown-it",
@@ -17,6 +17,7 @@
   },
   "license": "MIT",
   "author": "meteorlxy <meteor.lxy@foxmail.com>",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -27,22 +28,25 @@
   "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",
     "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,31 +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/shared
-
-# [0.4.0](https://github.com/mdit-vue/mdit-vue/compare/v0.3.1...v0.4.0) (2022-07-02)
-
-**Note:** Version bump only for package @mdit-vue/shared
-
-# [0.3.0](https://github.com/mdit-vue/mdit-vue/compare/v0.2.0...v0.3.0) (2022-06-25)
-
-### Features
-
-- **plugin-toc:** add toc plugin ([e64cc2c](https://github.com/mdit-vue/mdit-vue/commit/e64cc2ce3bbc89999d373f8a00fb3a049d6af58f))
-- **shared:** add html escape and unescape utils ([e1103c2](https://github.com/mdit-vue/mdit-vue/commit/e1103c21998aec77c67cdefd3cbb4994c127124c))
-
-# [0.2.0](https://github.com/mdit-vue/mdit-vue/compare/v0.1.1...v0.2.0) (2022-06-23)
-
-### Features
-
-- **shared:** add shared package ([9e36bdc](https://github.com/mdit-vue/mdit-vue/commit/9e36bdce8635ae048e8b0f2cc2d02cc0448ad09f))

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/html-escape.ts

@@ -1,18 +0,0 @@
-const htmlEscapeMap = {
-  '&': '&',
-  '<': '&lt;',
-  '>': '&gt;',
-  "'": '&#39;',
-  '"': '&quot;',
-};
-
-const htmlEscapeRegexp = /[&<>'"]/g;
-
-/**
- * Escape html chars
- */
-export const htmlEscape = (str: string): string =>
-  str.replace(
-    htmlEscapeRegexp,
-    (char) => htmlEscapeMap[char as keyof typeof htmlEscapeMap],
-  );

package/src/html-unescape.ts

@@ -1,23 +0,0 @@
-const htmlUnescapeMap = {
-  '&': '&',
-  '&': '&',
-  '&lt;': '<',
-  '&#60;': '<',
-  '&gt;': '>',
-  '&#62;': '>',
-  '&apos;': "'",
-  '&#39;': "'",
-  '&quot;': '"',
-  '&#34;': '"',
-};
-
-const htmlUnescapeRegexp = /&(amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
-
-/**
- * Unescape html chars
- */
-export const htmlUnescape = (str: string): string =>
-  str.replace(
-    htmlUnescapeRegexp,
-    (char) => htmlUnescapeMap[char as keyof typeof htmlUnescapeMap],
-  );

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from './html-escape';
-export * from './html-unescape';
-export * from './resolve-headers-from-tokens';
-export * from './resolve-title-from-token';
-export * from './slugify';

package/src/resolve-headers-from-tokens.ts

@@ -1,88 +0,0 @@
-import type { MarkdownItHeader } from '@mdit-vue/types';
-import type Token from 'markdown-it/lib/token';
-import { resolveTitleFromToken } from './resolve-title-from-token';
-
-/**
- * Resolve headers from markdown-it tokens
- */
-export const resolveHeadersFromTokens = (
-  tokens: Token[],
-  {
-    level,
-    shouldAllowHtml,
-    shouldEscapeText,
-    slugify,
-    format,
-  }: {
-    level: number[];
-    shouldAllowHtml: boolean;
-    shouldEscapeText: boolean;
-    slugify: (str: string) => string;
-    format?: (str: string) => string;
-  },
-): MarkdownItHeader[] => {
-  // store the result of headers
-  const headers: MarkdownItHeader[] = [];
-
-  // a temp headers stack for generating the headers tree
-  const stack: MarkdownItHeader[] = [];
-
-  // push a header to the headers tree
-  const push = (header: MarkdownItHeader): void => {
-    while (stack.length !== 0 && header.level <= stack[0].level) {
-      stack.shift();
-    }
-
-    if (stack.length === 0) {
-      headers.push(header);
-      stack.push(header);
-    } else {
-      stack[0].children.push(header);
-      stack.unshift(header);
-    }
-  };
-
-  tokens.forEach((_, idx) => {
-    const token = tokens[idx];
-
-    // if the token type does not match, skip
-    if (token?.type !== 'heading_open') {
-      return;
-    }
-
-    // get the level from the tag, h1 -> 1
-    const headerLevel = Number.parseInt(token.tag.slice(1), 10);
-
-    // if the level should not be extracted, skip
-    if (!level.includes(headerLevel)) {
-      return;
-    }
-
-    // the next token of 'heading_open' contains the heading content
-    const nextToken = tokens[idx + 1];
-
-    // if the next token does not exist, skip
-    if (!nextToken) {
-      return;
-    }
-
-    const title = resolveTitleFromToken(nextToken, {
-      shouldAllowHtml,
-      shouldEscapeText,
-    });
-
-    // the id of the heading anchor is the slugify result of markdown-it-anchor
-    // if the id does not exist, slugify the title ourselves
-    const slug = token.attrGet('id') ?? slugify(title);
-
-    // push the header to tree
-    push({
-      level: headerLevel,
-      title: format?.(title) ?? title,
-      slug,
-      children: [],
-    });
-  });
-
-  return headers;
-};

package/src/resolve-title-from-token.ts

@@ -1,52 +0,0 @@
-import type Token from 'markdown-it/lib/token';
-import { htmlEscape } from './html-escape';
-
-/**
- * Resolve header title from markdown-it token
- *
- * Typically using the next token of `heading_open` token
- */
-export const resolveTitleFromToken = (
-  token: Token,
-  {
-    shouldAllowHtml,
-    shouldEscapeText,
-  }: {
-    shouldAllowHtml: boolean;
-    shouldEscapeText: boolean;
-  },
-): string => {
-  // children of the token contains the parsed result of the heading title
-  const children = token.children ?? [];
-
-  // type of tokens to be included in the heading title
-  const titleTokenTypes = ['text', 'emoji', 'code_inline'];
-
-  // include 'html_inline' or not
-  if (shouldAllowHtml) {
-    titleTokenTypes.push('html_inline');
-  }
-
-  // filter the token type to be included in the title
-  const titleTokens = children.filter(
-    (item) =>
-      titleTokenTypes.includes(item.type) &&
-      // filter permalink symbol that generated by markdown-it-anchor
-      !item.meta?.isPermalinkSymbol,
-  );
-
-  // get title from tokens
-  return titleTokens
-    .reduce((result, item) => {
-      if (shouldEscapeText) {
-        // escape the content of 'code_inline' and 'text'
-        if (item.type === 'code_inline' || item.type === 'text') {
-          return `${result}${htmlEscape(item.content)}`;
-        }
-      }
-
-      // keep the content of 'emoji' and 'html_inline'
-      return `${result}${item.content}`;
-    }, '')
-    .trim();
-};

package/src/slugify.ts

@@ -1,25 +0,0 @@
-// eslint-disable-next-line no-control-regex
-const rControl = /[\u0000-\u001f]/g;
-const rSpecial = /[\s~`!@#$%^&*()\-_+=[\]{}|\\;:"'“”‘’<>,.?/]+/g;
-const rCombining = /[\u0300-\u036F]/g;
-
-/**
- * Default slugification function
- */
-export const slugify = (str: string): string =>
-  str
-    .normalize('NFKD')
-    // Remove accents
-    .replace(rCombining, '')
-    // Remove control characters
-    .replace(rControl, '')
-    // Replace special characters
-    .replace(rSpecial, '-')
-    // Remove continuos separators
-    .replace(/-{2,}/g, '-')
-    // Remove prefixing and trailing separators
-    .replace(/^-+|-+$/g, '')
-    // ensure it doesn't start with a number (#121)
-    .replace(/^(\d)/, '_$1')
-    // lowercase
-    .toLowerCase();

package/tests/html-escape.spec.ts

@@ -1,14 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { htmlEscape } from '../src';
-
-const testCases = [['&<>\'"', '&amp;&lt;&gt;&#39;&quot;']];
-
-describe('shared > html-escape', () => {
-  describe('should escape special chars', () => {
-    testCases.forEach(([source, expected]) => {
-      it(source, () => {
-        expect(htmlEscape(source)).toBe(expected);
-      });
-    });
-  });
-});

package/tests/html-unescape.spec.ts

@@ -1,21 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { htmlUnescape } from '../src';
-
-const testCases = [
-  ['&amp;&#38;&lt;&#60;&gt;&#62;&apos;&#39;&quot;&#34;', '&&<<>>\'\'""'],
-  ['&amp;lt;', '&lt;'],
-  [
-    '&amp;lt;script&amp;gt;&amp;lt;/script&amp;gt;',
-    '&lt;script&gt;&lt;/script&gt;',
-  ],
-];
-
-describe('shared > html-unescape', () => {
-  describe('should unescape special chars', () => {
-    testCases.forEach(([source, expected]) => {
-      it(source, () => {
-        expect(htmlUnescape(source)).toBe(expected);
-      });
-    });
-  });
-});

package/tests/slugify.spec.ts

@@ -1,35 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { slugify } from '../src';
-
-const testCases: [string, string][] = [
-  ['Привет', 'привет'],
-  ['Лед üäöß', 'лед-uaoß'],
-  ['hangul 가', 'hangul-가'],
-  ['ع', 'ع'],
-  ['džℍΩ', 'dzhω'],
-  ['ｶi⁹', 'カi9'],
-  // ㌀ -> アパート'
-  ['㌀', decodeURIComponent('%E3%82%A2%E3%83%8F%E3%82%9A%E3%83%BC%E3%83%88')],
-  ['¼', '_1⁄4'],
-  ['džℍΩｶi⁹¼', 'dzhωカi91⁄4'],
-  ['Iлｔèｒｎåｔïｏｎɑｌíƶａｔï߀ԉ', 'iлternationɑliƶati߀ԉ'],
-  [
-    'Båｃòл íｐѕùｍ ðｏɭ߀ｒ ѕïｔ ａϻèｔ âùþê ａԉᏧ߀üïｌɭê ƃëéｆ ｃｕｌρá ｆïｌèｔ ϻｉǥｎòｎ ｃｕρｉᏧａｔａｔ ｕｔ êлｉｍ ｔòлɢùê.',
-    'bacoл-ipѕum-ðoɭ߀r-ѕit-aϻet-auþe-aԉꮷ߀uilɭe-ƃeef-culρa-filet-ϻiǥnon-cuρiꮷatat-ut-eлim-toлɢue',
-  ],
-  ['ᴎᴑᴅᴇȷʂ', 'ᴎᴑᴅᴇȷʂ'],
-  ['hambúrguer', 'hamburguer'],
-  ['hŒllœ', 'hœllœ'],
-  ['Fußball', 'fußball'],
-  ['ABCDEFGHIJKLMNOPQRSTUVWXYZé', 'abcdefghijklmnopqrstuvwxyze'],
-];
-
-describe('shared > slugify', () => {
-  describe('should slugify string correctly', () => {
-    testCases.forEach(([source, expected]) => {
-      it(`${source} => ${expected}`, () => {
-        expect(slugify(source)).toBe(expected);
-      });
-    });
-  });
-});