@readme/markdown 11.7.5 → 11.7.7

package/dist/main.js

@@ -83028,13 +83028,30 @@ const rehypeToc = ({ components = {} }) => {
     };
 };
 const MAX_DEPTH = 2;
-const getDepth = (el) => parseInt(el.tagName?.match(/^h(\d)/)[1], 10);
+/**
+ * Get the depth of a heading element based on its tag name.
+ *
+ * ⚠️ Be extra defensive to non-heading elements somehow making it here. This
+ * should not happen, but if it does, we avoid breaking TOC depth calculations
+ * by returning `Infinity`, thus removing them from depth considerations.
+ * @link https://linear.app/readme-io/issue/CX-2543/tabapay-toc-does-not-respect-headers-nesting
+ *
+ * @example
+ * getDepth({ tagName: 'h1' }) // 1
+ * getDepth({ tagName: 'h2' }) // 2
+ */
+const getDepth = (el) => {
+    if (!el.tagName)
+        return Infinity;
+    return parseInt(el.tagName?.match(/^h(\d)/)[1], 10);
+};
 /*
  * `tocToHast` consumes the list generated by `rehypeToc` and produces a hast
  * of nested lists to be rendered as a table of contents.
  */
 const tocToHast = (headings = []) => {
-    const min = Math.min(...headings.map(getDepth));
+    const headingDepths = headings.map(getDepth);
+    const min = Math.min(...headingDepths);
     const ast = hastscript_lib_h('ul');
     const stack = [ast];
     headings.forEach(heading => {
@@ -83065,7 +83082,10 @@ const tocHastToMdx = (toc, components) => {
     if (typeof toc === 'undefined')
         return '';
     const injected = toc.flatMap(node => {
-        return node.type === 'mdxJsxFlowElement' && node.name in components ? components[node.name] || [] : node;
+        if (node.type === 'mdxJsxFlowElement') {
+            return components[node.name] || [];
+        }
+        return node;
     });
     const tocHast = tocToHast(injected);
     return lib_mdx({ type: 'root', children: [tocHast] }, { hast: true });
@@ -88437,9 +88457,12 @@ function extractMagicBlocks(markdown) {
     const blocks = [];
     let index = 0;
     const replaced = markdown.replace(MAGIC_BLOCK_REGEX, match => {
-        // Use backticks so it becomes a code span, preventing remarkParse from
-        // parsing special characters in the token as markdown syntax
-        const token = `\`__MAGIC_BLOCK_${index}__\``;
+        /**
+         * - Use backticks so it becomes a code span, preventing remarkParse from parsing
+         *   special characters in the token as markdown syntax
+         * - Prepend a newline to the token to ensure it is parsed as a block level node
+         */
+        const token = `\n\`__MAGIC_BLOCK_${index}__\``;
         blocks.push({ token, raw: match });
         index += 1;
         return token;

package/dist/main.node.js

@@ -103232,13 +103232,30 @@ const rehypeToc = ({ components = {} }) => {
     };
 };
 const MAX_DEPTH = 2;
-const getDepth = (el) => parseInt(el.tagName?.match(/^h(\d)/)[1], 10);
+/**
+ * Get the depth of a heading element based on its tag name.
+ *
+ * ⚠️ Be extra defensive to non-heading elements somehow making it here. This
+ * should not happen, but if it does, we avoid breaking TOC depth calculations
+ * by returning `Infinity`, thus removing them from depth considerations.
+ * @link https://linear.app/readme-io/issue/CX-2543/tabapay-toc-does-not-respect-headers-nesting
+ *
+ * @example
+ * getDepth({ tagName: 'h1' }) // 1
+ * getDepth({ tagName: 'h2' }) // 2
+ */
+const getDepth = (el) => {
+    if (!el.tagName)
+        return Infinity;
+    return parseInt(el.tagName?.match(/^h(\d)/)[1], 10);
+};
 /*
  * `tocToHast` consumes the list generated by `rehypeToc` and produces a hast
  * of nested lists to be rendered as a table of contents.
  */
 const tocToHast = (headings = []) => {
-    const min = Math.min(...headings.map(getDepth));
+    const headingDepths = headings.map(getDepth);
+    const min = Math.min(...headingDepths);
     const ast = hastscript_lib_h('ul');
     const stack = [ast];
     headings.forEach(heading => {
@@ -103269,7 +103286,10 @@ const tocHastToMdx = (toc, components) => {
     if (typeof toc === 'undefined')
         return '';
     const injected = toc.flatMap(node => {
-        return node.type === 'mdxJsxFlowElement' && node.name in components ? components[node.name] || [] : node;
+        if (node.type === 'mdxJsxFlowElement') {
+            return components[node.name] || [];
+        }
+        return node;
     });
     const tocHast = tocToHast(injected);
     return lib_mdx({ type: 'root', children: [tocHast] }, { hast: true });
@@ -108641,9 +108661,12 @@ function extractMagicBlocks(markdown) {
     const blocks = [];
     let index = 0;
     const replaced = markdown.replace(MAGIC_BLOCK_REGEX, match => {
-        // Use backticks so it becomes a code span, preventing remarkParse from
-        // parsing special characters in the token as markdown syntax
-        const token = `\`__MAGIC_BLOCK_${index}__\``;
+        /**
+         * - Use backticks so it becomes a code span, preventing remarkParse from parsing
+         *   special characters in the token as markdown syntax
+         * - Prepend a newline to the token to ensure it is parsed as a block level node
+         */
+        const token = `\n\`__MAGIC_BLOCK_${index}__\``;
         blocks.push({ token, raw: match });
         index += 1;
         return token;