@mintlify/common 1.0.1172 → 1.0.1174

package/dist/mdx/preprocessCustomHeadingIds.js

@@ -7,6 +7,7 @@ const MDX_HEADING_ID_RE = /^(\s*)(#{1,6})\s+(.+?)\s*\{\s*#([^}]+?)\s*\}\s*$/;
 // `<MDX>` or `<MDX className="x">`; not `<MDX />` (no body) and not `<MDXProvider>`
 const MDX_OPEN_RE = /<MDX(?:\s[^>]*[^/>\s])?\s*>/g;
 const MDX_CLOSE_RE = /<\/MDX\s*>/g;
+const COMMENT_MASK_RE = /(`+).*?\1|"[^"\n]*"/g;
 const UNSAFE_HTML_ATTR_CHARS = /[<>"]/g;
 /**
  * Characters to strip from custom heading IDs in the default (non-editor) path.
@@ -44,6 +45,7 @@ export function preprocessCustomHeadingIds(content, options) {
     let fenceChar;
     let fenceCount = 0;
     let mdxDepth = 0;
+    let inComment = false;
     for (const line of lines) {
         const stripped = line.trimStart();
         if (fenceChar !== undefined) {
@@ -53,15 +55,19 @@ export function preprocessCustomHeadingIds(content, options) {
             result.push(line);
             continue;
         }
-        const fence = parseOpeningFence(stripped);
+        const fence = !inComment && parseOpeningFence(stripped);
         if (fence) {
             fenceChar = fence.char;
             fenceCount = fence.count;
             result.push(line);
             continue;
         }
-        const heading = (mdxDepth > 0 ? MDX_HEADING_ID_RE : HEADING_ID_RE).exec(line);
-        if ((heading === null || heading === void 0 ? void 0 : heading[2]) && heading[3] && heading[4]) {
+        const { visible, inComment: endsInComment } = scanComments(line, inComment);
+        const commented = inComment || endsInComment;
+        inComment = endsInComment;
+        const headingRe = mdxDepth > 0 ? MDX_HEADING_ID_RE : HEADING_ID_RE;
+        const heading = !commented && headingRe.exec(line);
+        if (heading && heading[2] && heading[3] && heading[4]) {
             const indent = (_a = heading[1]) !== null && _a !== void 0 ? _a : '';
             const level = heading[2].length;
             const sanitizedId = (options === null || options === void 0 ? void 0 : options.preserveOriginal)
@@ -70,11 +76,32 @@ export function preprocessCustomHeadingIds(content, options) {
             result.push(`${indent}<h${level} id="${sanitizedId}">`, `${indent}${heading[3]}`, `${indent}</h${level}>`);
             continue;
         }
-        mdxDepth = Math.max(0, mdxDepth + ((_c = (_b = line.match(MDX_OPEN_RE)) === null || _b === void 0 ? void 0 : _b.length) !== null && _c !== void 0 ? _c : 0) - ((_e = (_d = line.match(MDX_CLOSE_RE)) === null || _d === void 0 ? void 0 : _d.length) !== null && _e !== void 0 ? _e : 0));
+        mdxDepth = Math.max(0, mdxDepth +
+            ((_c = (_b = visible.match(MDX_OPEN_RE)) === null || _b === void 0 ? void 0 : _b.length) !== null && _c !== void 0 ? _c : 0) -
+            ((_e = (_d = visible.match(MDX_CLOSE_RE)) === null || _d === void 0 ? void 0 : _d.length) !== null && _e !== void 0 ? _e : 0));
         result.push(line);
     }
     return result.join('\n');
 }
+function scanComments(line, inComment) {
+    const masked = line.replace(COMMENT_MASK_RE, (span) => ' '.repeat(span.length));
+    let visible = '';
+    let pos = 0;
+    for (;;) {
+        if (inComment) {
+            const close = line.indexOf('*/', pos);
+            if (close === -1)
+                return { visible, inComment };
+            pos = close + 2;
+        }
+        const open = masked.indexOf('{/*', pos);
+        if (open === -1)
+            return { visible: visible + line.slice(pos), inComment: false };
+        visible += line.slice(pos, open);
+        pos = open + 3;
+        inComment = true;
+    }
+}
 export function parseOpeningFence(stripped) {
     const char = stripped[0];
     if (char !== '`' && char !== '~')

package/dist/mdx/preprocessCustomHeadingIds.test.js

@@ -73,6 +73,91 @@ describe('preprocessCustomHeadingIds', () => {
   \`\`\``;
         expect(preprocessCustomHeadingIds(input)).toBe(input);
     });
+    it('converts headings after a comment whose closing fence shares a line with */}', () => {
+        const input = `{/* Note
+
+  \`\`\`python
+  run.log({'loss': 0.2})
+  \`\`\` */}
+
+## After {#after}`;
+        expect(preprocessCustomHeadingIds(input)).toContain('<h2 id="after">\nAfter\n</h2>');
+    });
+    it('converts headings after a comment whose closing fence is on its own line', () => {
+        const input = `{/* Note
+
+  \`\`\`python
+  run.log({'loss': 0.2})
+  \`\`\`
+  */}
+
+## After {#after}`;
+        expect(preprocessCustomHeadingIds(input)).toContain('<h2 id="after">\nAfter\n</h2>');
+    });
+    it('converts headings after an inline comment whose closing fence shares a line with */}', () => {
+        const input = `<Note>{/* Note
+
+\`\`\`python
+x = 1
+\`\`\` */}</Note>
+
+## After {#after}`;
+        expect(preprocessCustomHeadingIds(input)).toContain('<h2 id="after">\nAfter\n</h2>');
+    });
+    it('ignores comment openers inside inline code', () => {
+        expect(preprocessCustomHeadingIds('Use `{/*` to open a comment.\n\n## After {#after}')).toContain('<h2 id="after">\nAfter\n</h2>');
+    });
+    it('tracks a comment reopened on the line that closes the previous one', () => {
+        const input = '{/* one\n*/} {/* two\n## Hidden {#hidden}\n*/}\n\n## After {#after}';
+        const output = preprocessCustomHeadingIds(input);
+        expect(output).toContain('## Hidden {#hidden}');
+        expect(output).toContain('<h2 id="after">\nAfter\n</h2>');
+    });
+    it('ignores comment openers inside quoted attribute values', () => {
+        expect(preprocessCustomHeadingIds('<Note title="{/*">\nBody\n</Note>\n\n## After {#after}')).toContain('<h2 id="after">\nAfter\n</h2>');
+    });
+    it('tracks a comment opened between apostrophes in prose', () => {
+        const input = "Don't miss {/* it's hidden\n## Hidden {#hidden}\n*/}\n\n## After {#after}";
+        const output = preprocessCustomHeadingIds(input);
+        expect(output).toContain('## Hidden {#hidden}');
+        expect(output).toContain('<h2 id="after">\nAfter\n</h2>');
+    });
+    it('counts an <MDX> tag that shares a line with a comment', () => {
+        const input = '<MDX>{/* note\n*/}\n    ## Heading {#heading}\n</MDX>';
+        expect(preprocessCustomHeadingIds(input)).toContain('    <h2 id="heading">\n    Heading\n    </h2>');
+    });
+    it('ignores <MDX> tags inside comments', () => {
+        for (const input of [
+            '{/* <MDX> */}\n\n    ## Still code {#not-converted}',
+            '{/*\n<MDX>\n*/}\n\n    ## Still code {#not-converted}',
+        ]) {
+            expect(preprocessCustomHeadingIds(input)).toBe(input);
+        }
+    });
+    it('ends a comment at */ regardless of what precedes the closing brace', () => {
+        for (const comment of [
+            '{/* note */ }',
+            '{/*\n  note\n*/\n}',
+            '<Note data-x={/* x */ 1}>\nBody\n</Note>',
+        ]) {
+            expect(preprocessCustomHeadingIds(`${comment}\n\n## After {#after}`)).toContain('<h2 id="after">\nAfter\n</h2>');
+        }
+    });
+    it('converts headings after a single-line comment', () => {
+        expect(preprocessCustomHeadingIds('{/* Note */}\n\n## After {#after}')).toContain('<h2 id="after">\nAfter\n</h2>');
+    });
+    it('leaves headings inside a comment alone', () => {
+        const input = '{/*\n## Heading {#custom-id}\n*/}';
+        expect(preprocessCustomHeadingIds(input)).toBe(input);
+    });
+    it('does not treat a comment opener inside a code fence as a comment', () => {
+        const input = `\`\`\`mdx
+{/* Note
+\`\`\`
+
+## After {#after}`;
+        expect(preprocessCustomHeadingIds(input)).toContain('<h2 id="after">\nAfter\n</h2>');
+    });
     it('normalizes ids by default', () => {
         expect(preprocessCustomHeadingIds('  ## Heading {#my id!}')).toBe('  <h2 id="my-id">\n  Heading\n  </h2>');
     });