@mdit-vue/shared 0.4.0 → 0.7.0

package/CHANGELOG.md

@@ -3,6 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.7.0](https://github.com/mdit-vue/mdit-vue/compare/v0.6.0...v0.7.0) (2022-07-18)
+
+**Note:** Version bump only for package @mdit-vue/shared
+
+# [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

package/README.md

@@ -1,32 +1,11 @@
 # @mdit-vue/shared
 
-[![npm](https://badgen.net/npm/v/@mdit-vue/shared)](https://www.npmjs.com/package/@mdit-vue/plugin-sfc)
+[![npm](https://badgen.net/npm/v/@mdit-vue/shared)](https://www.npmjs.com/package/@mdit-vue/shared)
 
-Shared utils and types of mdit-vue.
+Shared utils of mdit-vue.
 
 ## Install
 
 ```sh
 npm i @mdit-vue/shared
 ```
-
-## Usage
-
-Add more properties to `env` via [TypeScript module augmentation](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation):
-
-```ts
-declare module '@mdit-vue/shared' {
-  interface MarkdownItEnv {
-    foo?: string[];
-  }
-}
-```
-
-```ts
-import MarkdownIt from 'markdown-it';
-import type { MarkdownItEnv } from '@mdit-vue/shared';
-
-const md = MarkdownIt({ html: true });
-const env: MarkdownItEnv = {};
-const rendered = md.render('raw markdown text', env);
-```

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,3 +1,4 @@
+import { MarkdownItHeader } from '@mdit-vue/types';
 import Token from 'markdown-it/lib/token';
 
 /**
@@ -10,39 +11,53 @@ declare const htmlEscape: (str: string) => string;
  */
 declare const htmlUnescape: (str: string) => string;
 
-interface MarkdownItEnv {
-}
-interface MarkdownItHeader {
-    level: number;
-    title: string;
-    slug: string;
-    children: MarkdownItHeader[];
-}
-
-/**
- * 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 { MarkdownItEnv, MarkdownItHeader, 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,10 +1,11 @@
 {
   "name": "@mdit-vue/shared",
-  "version": "0.4.0",
+  "version": "0.7.0",
   "description": "Shared utils and types of mdit-vue",
   "keywords": [
     "markdown-it",
-    "vue"
+    "vue",
+    "utils"
   ],
   "homepage": "https://github.com/mdit-vue",
   "bugs": {
@@ -31,16 +32,17 @@
     "test": "vitest"
   },
   "dependencies": {
+    "@mdit-vue/types": "0.7.0",
     "@types/markdown-it": "^12.2.3",
     "markdown-it": "^13.0.1"
   },
   "devDependencies": {
     "c8": "^7.11.3",
     "unbuild": "^0.7.4",
-    "vitest": "^0.16.0"
+    "vitest": "^0.18.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "744887e6f4733af8da2045625e72a476947cfc25"
+  "gitHead": "dd30ddd75ca461f775ccc35556132851ebc5e58a"
 }

package/src/index.ts

@@ -3,4 +3,3 @@ export * from './html-unescape';
 export * from './resolve-headers-from-tokens';
 export * from './resolve-title-from-token';
 export * from './slugify';
-export * from './types';

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

@@ -1,6 +1,26 @@
+import type { MarkdownItHeader } from '@mdit-vue/types';
 import type Token from 'markdown-it/lib/token';
 import { resolveTitleFromToken } from './resolve-title-from-token';
-import type { MarkdownItHeader } from './types';
+import type { ResolveTitleOptions } from './resolve-title-from-token';
+
+export 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
@@ -13,13 +33,7 @@ export const resolveHeadersFromTokens = (
     shouldEscapeText,
     slugify,
     format,
-  }: {
-    level: number[];
-    shouldAllowHtml: boolean;
-    shouldEscapeText: boolean;
-    slugify: (str: string) => string;
-    format?: (str: string) => string;
-  },
+  }: ResolveHeadersOptions,
 ): MarkdownItHeader[] => {
   // store the result of headers
   const headers: MarkdownItHeader[] = [];

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

@@ -1,6 +1,24 @@
 import type Token from 'markdown-it/lib/token';
 import { htmlEscape } from './html-escape';
 
+export 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
  *
@@ -8,13 +26,7 @@ import { htmlEscape } from './html-escape';
  */
 export const resolveTitleFromToken = (
   token: Token,
-  {
-    shouldAllowHtml,
-    shouldEscapeText,
-  }: {
-    shouldAllowHtml: boolean;
-    shouldEscapeText: boolean;
-  },
+  { shouldAllowHtml, shouldEscapeText }: ResolveTitleOptions,
 ): string => {
   // children of the token contains the parsed result of the heading title
   const children = token.children ?? [];

package/src/types.ts

@@ -1,11 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface MarkdownItEnv {
-  // to be extended with module augmentation
-}
-
-export interface MarkdownItHeader {
-  level: number;
-  title: string;
-  slug: string;
-  children: MarkdownItHeader[];
-}