@mdit-vue/shared 3.0.0 → 3.0.2

package/dist/index.d.ts

@@ -1,70 +1,84 @@
-import { MarkdownItHeader } from '@mdit-vue/types';
-import Token from 'markdown-it/lib/token.mjs';
+import { MarkdownItHeader } from "@mdit-vue/types";
+import Token from "markdown-it/lib/token.mjs";
 
+//#region src/html-escape.d.ts
 /**
  * Escape html chars
  */
 declare const htmlEscape: (str: string) => string;
-
+//#endregion
+//#region src/html-unescape.d.ts
 /**
  * Unescape html chars
  */
 declare const htmlUnescape: (str: string) => string;
-
+//#endregion
+//#region src/resolve-title-from-token.d.ts
 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;
+  /**
+   * 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;
 }
 /**
  * Resolve header title from markdown-it token
  *
  * Typically using the next token of `heading_open` token
  */
-declare const resolveTitleFromToken: (token: Token, { shouldAllowHtml, shouldEscapeText }: ResolveTitleOptions) => string;
-
+declare const resolveTitleFromToken: (token: Token, {
+  shouldAllowHtml,
+  shouldEscapeText
+}: ResolveTitleOptions) => string;
+//#endregion
+//#region src/resolve-headers-from-tokens.d.ts
 interface ResolveHeadersOptions extends ResolveTitleOptions {
-    /**
-     * Heading level that going to be resolved
-     */
-    level: number[];
-    /**
-     * Should allow headers inside nested blocks or not
-     *
-     * If set to `true`, headers inside blockquote, list, etc. would also be resolved.
-     */
-    shouldAllowNested: boolean;
-    /**
-     * 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;
+  /**
+   * Heading level that going to be resolved
+   */
+  level: number[];
+  /**
+   * Should allow headers inside nested blocks or not
+   *
+   * If set to `true`, headers inside blockquote, list, etc. would also be resolved.
+   */
+  shouldAllowNested: boolean;
+  /**
+   * 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, shouldAllowNested, shouldEscapeText, slugify, format, }: ResolveHeadersOptions) => MarkdownItHeader[];
-
+declare const resolveHeadersFromTokens: (tokens: Token[], {
+  level,
+  shouldAllowHtml,
+  shouldAllowNested,
+  shouldEscapeText,
+  slugify,
+  format
+}: ResolveHeadersOptions) => MarkdownItHeader[];
+//#endregion
+//#region src/slugify.d.ts
 /**
  * Default slugification function
  */
-declare const slugify: (str: string) => string;
-
-export { htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify };
-export type { ResolveHeadersOptions, ResolveTitleOptions };
+declare const slugify$1: (str: string) => string;
+//#endregion
+export { ResolveHeadersOptions, ResolveTitleOptions, htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify$1 as slugify };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdit-vue/shared",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Shared utils and types of mdit-vue",
   "keywords": [
     "markdown-it",
@@ -19,29 +19,27 @@
   "author": "meteorlxy <meteor.lxy@foxmail.com>",
   "type": "module",
   "exports": {
-    ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
-    },
+    ".": "./dist/index.js",
     "./package.json": "./package.json"
   },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.cts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "./dist"
   ],
   "scripts": {
     "build": "tsdown",
+    "clean": "rimraf ./dist",
     "test": "vitest"
   },
   "dependencies": {
-    "@mdit-vue/types": "3.0.0",
+    "@mdit-vue/types": "3.0.2",
     "@types/markdown-it": "^14.1.2",
     "markdown-it": "^14.1.0"
   },
   "devDependencies": {
-    "tsdown": "^0.14.0",
+    "tsdown": "^0.14.1",
     "vitest": "^3.2.4"
   },
   "engines": {
@@ -50,5 +48,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "bbb62a47109c2932505b3f570b963f70d590914f"
+  "gitHead": "3b5332d09fbd927319bd8be3ba3b86b3d12d1ec8"
 }

package/dist/index.cjs

@@ -1,118 +0,0 @@
-
-//#region src/html-escape.ts
-const htmlEscapeMap = {
-	"&": "&",
-	"<": "&lt;",
-	">": "&gt;",
-	"'": "&#39;",
-	"\"": "&quot;"
-};
-const htmlEscapeRegexp = /[&<>'"]/g;
-/**
-* Escape html chars
-*/
-const htmlEscape = (str) => str.replace(htmlEscapeRegexp, (char) => htmlEscapeMap[char]);
-
-//#endregion
-//#region src/html-unescape.ts
-const htmlUnescapeMap = {
-	"&amp;": "&",
-	"&#38;": "&",
-	"&lt;": "<",
-	"&#60;": "<",
-	"&gt;": ">",
-	"&#62;": ">",
-	"&apos;": "'",
-	"&#39;": "'",
-	"&quot;": "\"",
-	"&#34;": "\""
-};
-const htmlUnescapeRegexp = /&(amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
-/**
-* Unescape html chars
-*/
-const htmlUnescape = (str) => str.replace(htmlUnescapeRegexp, (char) => htmlUnescapeMap[char]);
-
-//#endregion
-//#region src/resolve-title-from-token.ts
-/**
-* Resolve header title from markdown-it token
-*
-* Typically using the next token of `heading_open` token
-*/
-const resolveTitleFromToken = (token, { shouldAllowHtml, shouldEscapeText }) => {
-	const children = token.children ?? [];
-	const titleTokenTypes = [
-		"text",
-		"emoji",
-		"code_inline"
-	];
-	if (shouldAllowHtml) titleTokenTypes.push("html_inline");
-	const titleTokens = children.filter((item) => titleTokenTypes.includes(item.type) && !item.meta?.isPermalinkSymbol);
-	return titleTokens.reduce((result, item) => {
-		if (shouldEscapeText) {
-			if (item.type === "code_inline" || item.type === "text") return `${result}${htmlEscape(item.content)}`;
-		}
-		return `${result}${item.content}`;
-	}, "").trim();
-};
-
-//#endregion
-//#region src/resolve-headers-from-tokens.ts
-/**
-* Resolve headers from markdown-it tokens
-*/
-const resolveHeadersFromTokens = (tokens, { level, shouldAllowHtml, shouldAllowNested, shouldEscapeText, slugify: slugify$1, format }) => {
-	const headers = [];
-	const stack = [];
-	const push = (header) => {
-		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);
-		}
-	};
-	for (let i = 0; i < tokens.length; i += 1) {
-		const token = tokens[i];
-		if (token.type !== "heading_open") continue;
-		if (token.level !== 0 && !shouldAllowNested) continue;
-		const headerLevel = Number.parseInt(token.tag.slice(1), 10);
-		if (!level.includes(headerLevel)) continue;
-		const nextToken = tokens[i + 1];
-		/* istanbul ignore if -- @preserve */
-		if (!nextToken) continue;
-		const title = resolveTitleFromToken(nextToken, {
-			shouldAllowHtml,
-			shouldEscapeText
-		});
-		const slug = token.attrGet("id") ?? slugify$1(title);
-		push({
-			level: headerLevel,
-			title: format?.(title) ?? title,
-			slug,
-			link: `#${slug}`,
-			children: []
-		});
-	}
-	return headers;
-};
-
-//#endregion
-//#region src/slugify.ts
-const rControl = /[\u0000-\u001f]/g;
-const rSpecial = /[\s~`!@#$%^&*()\-_+=[\]{}|\\;:"'“”‘’<>,.?/]+/g;
-const rCombining = /[\u0300-\u036F]/g;
-/**
-* Default slugification function
-*/
-const slugify = (str) => str.normalize("NFKD").replace(rCombining, "").replace(rControl, "").replace(rSpecial, "-").replace(/-{2,}/g, "-").replace(/^-+|-+$/g, "").replace(/^(\d)/, "_$1").toLowerCase();
-
-//#endregion
-exports.htmlEscape = htmlEscape;
-exports.htmlUnescape = htmlUnescape;
-exports.resolveHeadersFromTokens = resolveHeadersFromTokens;
-exports.resolveTitleFromToken = resolveTitleFromToken;
-exports.slugify = slugify;

package/dist/index.d.cts

@@ -1,84 +0,0 @@
-import { MarkdownItHeader } from "@mdit-vue/types";
-import Token from "markdown-it/lib/token.mjs";
-
-//#region src/html-escape.d.ts
-/**
- * Escape html chars
- */
-declare const htmlEscape: (str: string) => string;
-//#endregion
-//#region src/html-unescape.d.ts
-/**
- * Unescape html chars
- */
-declare const htmlUnescape: (str: string) => string;
-//#endregion
-//#region src/resolve-title-from-token.d.ts
-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;
-}
-/**
- * Resolve header title from markdown-it token
- *
- * Typically using the next token of `heading_open` token
- */
-declare const resolveTitleFromToken: (token: Token, {
-  shouldAllowHtml,
-  shouldEscapeText
-}: ResolveTitleOptions) => string;
-//#endregion
-//#region src/resolve-headers-from-tokens.d.ts
-interface ResolveHeadersOptions extends ResolveTitleOptions {
-  /**
-   * Heading level that going to be resolved
-   */
-  level: number[];
-  /**
-   * Should allow headers inside nested blocks or not
-   *
-   * If set to `true`, headers inside blockquote, list, etc. would also be resolved.
-   */
-  shouldAllowNested: boolean;
-  /**
-   * 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,
-  shouldAllowNested,
-  shouldEscapeText,
-  slugify,
-  format
-}: ResolveHeadersOptions) => MarkdownItHeader[];
-//#endregion
-//#region src/slugify.d.ts
-/**
- * Default slugification function
- */
-declare const slugify$1: (str: string) => string;
-//#endregion
-export { ResolveHeadersOptions, ResolveTitleOptions, htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify$1 as slugify };

package/dist/index.d.mts

@@ -1,84 +0,0 @@
-import { MarkdownItHeader } from "@mdit-vue/types";
-import Token from "markdown-it/lib/token.mjs";
-
-//#region src/html-escape.d.ts
-/**
- * Escape html chars
- */
-declare const htmlEscape: (str: string) => string;
-//#endregion
-//#region src/html-unescape.d.ts
-/**
- * Unescape html chars
- */
-declare const htmlUnescape: (str: string) => string;
-//#endregion
-//#region src/resolve-title-from-token.d.ts
-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;
-}
-/**
- * Resolve header title from markdown-it token
- *
- * Typically using the next token of `heading_open` token
- */
-declare const resolveTitleFromToken: (token: Token, {
-  shouldAllowHtml,
-  shouldEscapeText
-}: ResolveTitleOptions) => string;
-//#endregion
-//#region src/resolve-headers-from-tokens.d.ts
-interface ResolveHeadersOptions extends ResolveTitleOptions {
-  /**
-   * Heading level that going to be resolved
-   */
-  level: number[];
-  /**
-   * Should allow headers inside nested blocks or not
-   *
-   * If set to `true`, headers inside blockquote, list, etc. would also be resolved.
-   */
-  shouldAllowNested: boolean;
-  /**
-   * 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,
-  shouldAllowNested,
-  shouldEscapeText,
-  slugify,
-  format
-}: ResolveHeadersOptions) => MarkdownItHeader[];
-//#endregion
-//#region src/slugify.d.ts
-/**
- * Default slugification function
- */
-declare const slugify$1: (str: string) => string;
-//#endregion
-export { ResolveHeadersOptions, ResolveTitleOptions, htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify$1 as slugify };