@md-plugins/md-plugin-headers 0.1.0-alpha.28 → 0.1.0-alpha.29

package/dist/index.mjs

@@ -3,74 +3,95 @@ const rCombining = /[\u0300-\u036F]/g;
 const rControl = /[\u0000-\u001f]/g;
 const rSpecial = /[\s~`!@#$%^&*()\-_+=[\]{}|\\;:"'“”‘’<>,.?/]+/g;
 const slugify = (str) => str.trim().replace(/([a-z])([A-Z])/g, "$1-$2").replace(/[\s_]+/g, "-").toLowerCase().normalize("NFKD").replace(rCombining, "").replace(andRE, "-and-").replace(rControl, "-").replace(rSpecial, "-").replace(/[^a-z0-9-]+/g, "").replace(/([a-z])(\d)/g, "$1-$2").replace(/(\d)([a-z])/g, "$1-$2").replace(/-{2,}/g, "-").replace(/(^-|-$)/g, "").replace(/^(\d)/, "_$1");
+function resolvePluginOptions(options, key, defaults) {
+  if (options && typeof options === "object" && key in options) {
+    return { ...defaults, ...options[key] };
+  }
+  return { ...defaults, ...options };
+}
 
-const titleRE = /<\/?[^>]+(>|$)/g;
-const apiRE = /^<MarkdownApi /;
-const apiNameRE = /(?:file|name)="([^"]+)"/;
-const exampleRE = /^<MarkdownExample(?:\s+title="([^"]*)")?\s*/;
-function parseContent(str, slugify$1 = slugify, format = (_str) => _str) {
-  const title = String(str).replace(titleRE, "").trim();
+const DEFAULT_HEADERS_PLUGIN_OPTIONS = {
+  level: [2, 3],
+  slugify: slugify,
+  // Default to an identity function if no formatter is provided.
+  format: (str) => str,
+  shouldAllowNested: false,
+  shouldAllowApi: true,
+  shouldAllowExample: true
+};
+function parseContent(str, slugify, format) {
+  const title = String(str).replace(/<\/?[^>]+(>|$)/g, "").trim();
   return {
-    id: slugify$1(title),
-    title: format(title) ?? title
+    id: slugify(title),
+    title: format(title)
   };
 }
-const headersPlugin = (md, {
-  level = [2, 3],
-  slugify: slugify$1 = slugify,
-  format,
-  shouldAllowApi = true,
-  shouldAllowExample = true
-} = {}) => {
+const headersPlugin = (md, options) => {
+  const {
+    level = DEFAULT_HEADERS_PLUGIN_OPTIONS.level,
+    slugify = DEFAULT_HEADERS_PLUGIN_OPTIONS.slugify,
+    format = DEFAULT_HEADERS_PLUGIN_OPTIONS.format,
+    shouldAllowApi = DEFAULT_HEADERS_PLUGIN_OPTIONS.shouldAllowApi,
+    shouldAllowExample = DEFAULT_HEADERS_PLUGIN_OPTIONS.shouldAllowExample,
+    shouldAllowNested = DEFAULT_HEADERS_PLUGIN_OPTIONS.shouldAllowNested
+  } = resolvePluginOptions(
+    options,
+    "headersPlugin",
+    DEFAULT_HEADERS_PLUGIN_OPTIONS
+  );
   const originalHeadingOpen = md.renderer.rules.heading_open;
   const originalHtmlBlock = md.renderer.rules.html_block;
-  md.renderer.rules.heading_open = (tokens, idx, options, env, self) => {
+  md.renderer.rules.heading_open = (tokens, idx, options2, env, self) => {
     const token = tokens[idx];
     if (!token) {
-      return self.renderToken(tokens, idx, options);
+      return self.renderToken(tokens, idx, options2);
     }
     const headerLevel = Number.parseInt(token.tag.slice(1), 10);
     const contentToken = tokens[idx + 1];
     const content = contentToken && contentToken.children ? contentToken.children.reduce((acc, t) => acc + t.content, "") : "";
-    const { id, title } = parseContent(content, slugify$1, format);
+    const { id, title } = parseContent(content, slugify, format);
     token.attrSet("id", id);
     token.attrSet("class", `markdown-heading markdown-${token.tag}`);
     token.attrSet("@click", `copyHeading(\`${id}\`)`);
     env.toc = env.toc || [];
-    if (level.includes(headerLevel)) {
-      if (headerLevel === level[0]) {
+    if ((level ?? []).includes(headerLevel)) {
+      if (headerLevel === (level ?? [])[0]) {
         env.toc.push({ id, title });
       } else {
         env.toc.push({ id, title, sub: true });
       }
     }
     if (typeof originalHeadingOpen === "function") {
-      return originalHeadingOpen(tokens, idx, options, env, self);
+      return originalHeadingOpen(tokens, idx, options2, env, self);
     }
-    return self.renderToken(tokens, idx, options);
+    return self.renderToken(tokens, idx, options2);
   };
-  md.renderer.rules.html_block = (tokens, idx, options, env, self) => {
+  md.renderer.rules.html_block = (tokens, idx, options2, env, self) => {
     const token = tokens[idx];
     if (!token) {
       return "";
     }
     env.toc = env.toc || [];
-    if (shouldAllowApi && apiRE.test(token.content)) {
-      const match = apiNameRE.exec(token.content);
+    if (shouldAllowApi && /^<MarkdownApi\s/.test(token.content)) {
+      const match = /(?:file|name)="([^"]+)"/.exec(token.content);
       if (match !== null) {
         const title = `${match[1]} API`;
-        env.toc.push({ id: slugify$1(title), title, deep: true });
+        if (slugify) {
+          env.toc.push({ id: slugify(title), title, deep: true });
+        }
       }
     }
-    if (shouldAllowExample && exampleRE.test(token.content)) {
-      const match = token.content.match(exampleRE);
+    if (shouldAllowExample && /^<MarkdownExample(?:\s+title="([^"]*)")?\s*/.test(token.content)) {
+      const match = token.content.match(/^<MarkdownExample(?:\s+title="([^"]*)")?\s*/);
       if (match !== null) {
         const title = match[1] ?? "Example";
-        env.toc.push({ id: slugify$1("example-" + title), title, deep: true });
+        if (slugify) {
+          env.toc.push({ id: slugify("example-" + title), title, deep: true });
+        }
       }
     }
     if (typeof originalHtmlBlock === "function") {
-      return originalHtmlBlock(tokens, idx, options, env, self);
+      return originalHtmlBlock(tokens, idx, options2, env, self);
     }
     return token.content;
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@md-plugins/md-plugin-headers",
-  "version": "0.1.0-alpha.28",
+  "version": "0.1.0-alpha.29",
   "description": "A markdown-it plugin for handling headers (H1-H6).",
   "keywords": [
     "markdown-it",
@@ -35,7 +35,7 @@
   "devDependencies": {
     "markdown-it": "^14.1.0",
     "@types/markdown-it": "^14.1.2",
-    "@md-plugins/shared": "0.1.0-alpha.28"
+    "@md-plugins/shared": "0.1.0-alpha.29"
   },
   "peerDependencies": {
     "markdown-it": "^14.1.0"