@mintlify/common 1.0.1304 → 1.0.1305

package/dist/mdx/getCodeRanges.d.ts

@@ -0,0 +1 @@
+export declare const getCodeRanges: (content: string) => [start: number, end: number][];

package/dist/mdx/getCodeRanges.js

@@ -0,0 +1,22 @@
+import { parse, postprocess, preprocess } from 'micromark';
+import { frontmatter } from 'micromark-extension-frontmatter';
+import { gfmTable } from 'micromark-extension-gfm-table';
+const CODE_TYPES = new Set(['codeFenced', 'codeText', 'yaml', 'toml']);
+const extensions = [
+    frontmatter(['yaml', 'toml']),
+    gfmTable(),
+    { disable: { null: ['autolink', 'codeIndented', 'htmlFlow', 'htmlText'] } },
+];
+export const getCodeRanges = (content) => {
+    const bom = content.startsWith('') ? 1 : 0;
+    const events = postprocess(parse({ extensions })
+        .document()
+        .write(preprocess()(content.slice(bom), undefined, true)));
+    const ranges = [];
+    for (const [kind, token] of events) {
+        if (kind === 'enter' && CODE_TYPES.has(token.type)) {
+            ranges.push([token.start.offset + bom, token.end.offset + bom]);
+        }
+    }
+    return ranges;
+};

package/dist/mdx/getCodeRanges.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/mdx/getCodeRanges.test.js

@@ -0,0 +1,119 @@
+import { describe, expect, it } from 'vitest';
+import { getCodeRanges } from './getCodeRanges.js';
+const slices = (content) => getCodeRanges(content).map(([start, end]) => content.slice(start, end));
+describe('getCodeRanges', () => {
+    it('returns nothing for an empty page', () => {
+        expect(getCodeRanges('')).toEqual([]);
+    });
+    it('covers a fence including its fence lines', () => {
+        const content = 'Intro\n\n```js\nconst a = <br>;\n```\n\nOutro';
+        expect(getCodeRanges(content)).toEqual([[7, 32]]);
+        expect(slices(content)).toEqual(['```js\nconst a = <br>;\n```']);
+    });
+    it('covers a fence inside a blockquote', () => {
+        expect(slices('> Quote\n>\n> ```js\n> x\n> ```\n\nAfter')).toEqual(['```js\n> x\n> ```']);
+    });
+    it('does not close a fence on a line with an info string', () => {
+        expect(slices('```\na\n```js\nb\n```\nc')).toEqual(['```\na\n```js\nb\n```']);
+    });
+    it('runs an unclosed fence to the end of the file', () => {
+        expect(slices('Text\n\n```bash\necho hi\n\n<br>\n')).toEqual(['```bash\necho hi\n\n<br>\n']);
+    });
+    it('pairs inline code within a block but not across blank lines', () => {
+        expect(slices('Use `a` and ``b ` c``.')).toEqual(['`a`', '``b ` c``']);
+        expect(slices('Open `tick\n\nclose` here')).toEqual([]);
+    });
+    it('covers YAML frontmatter', () => {
+        expect(slices('---\ntitle: `x`\n---\n\nBody `y`')).toEqual(['---\ntitle: `x`\n---', '`y`']);
+    });
+    it('covers TOML frontmatter', () => {
+        expect(slices('+++\ntitle = "x"\n+++\n\nBody')).toEqual(['+++\ntitle = "x"\n+++']);
+    });
+    it('keeps offsets exact after a byte order mark', () => {
+        expect(slices('---\na: 1\n---\n\n`b`')).toEqual(['---\na: 1\n---', '`b`']);
+    });
+    it('does not treat indented lines inside JSX as code', () => {
+        expect(slices('<Card>\n    <br>\n    Text `x`\n</Card>')).toEqual(['`x`']);
+    });
+    it('finds fences indented inside JSX', () => {
+        expect(slices('<Tab>\n    ```js\n    x\n    ```\n</Tab>')).toEqual(['```js\n    x\n    ```']);
+    });
+    it('finds code on pages with broken JSX', () => {
+        const content = '<Card title="a">\n\nLine<br>\n\n```html\n<br>\n```\n\nSee `<br>`.\n';
+        expect(slices(content)).toEqual(['```html\n<br>\n```', '`<br>`']);
+    });
+    it('matches the mdast positions on a mixed page', () => {
+        const content = [
+            '---',
+            'title: `Page`',
+            '---',
+            '',
+            'Intro with `inline` and ``double ` tick`` code.',
+            '',
+            '<Card title="a">',
+            '',
+            'Line<br>',
+            '',
+            '```js title="x.js"',
+            'const a = <br>;',
+            '```',
+            '',
+            '> Quote',
+            '> ```bash',
+            '> echo `x`',
+            '> ```',
+            '',
+            '- Item `one`',
+            '',
+            '    ```py',
+            '    print(1)',
+            '    ```',
+            '',
+            '<Tab>',
+            '    indented `two`',
+            '</Tab>',
+            '',
+            'Open `tick',
+            '',
+            'close` here',
+            '',
+            '~~~',
+            'tilde',
+            '~~~',
+            '',
+            '```',
+            'unclosed',
+            '',
+        ].join('\n');
+        expect(getCodeRanges(content)).toEqual([
+            [0, 21],
+            [34, 42],
+            [47, 64],
+            [100, 138],
+            [150, 174],
+            [183, 188],
+            [194, 220],
+            [241, 246],
+            [280, 293],
+            [295, 308],
+        ]);
+        expect(getCodeRanges('+++\na = 1\n+++\n\n`b`')).toEqual([
+            [0, 13],
+            [15, 18],
+        ]);
+    });
+    it('does not pair backticks across table cells', () => {
+        expect(slices('| A | B |\n| - | - |\n| `open | <br> close` |')).toEqual([]);
+    });
+    it('covers inline code inside table cells', () => {
+        const content = '| A | B |\n| - | - |\n| `x` | y `<br>` |';
+        expect(getCodeRanges(content)).toEqual([
+            [22, 25],
+            [30, 36],
+        ]);
+        expect(slices(`${content}`)).toEqual(['`x`', '`<br>`']);
+    });
+    it('ignores HTML and autolink syntax like MDX does', () => {
+        expect(slices('<div>\n\n`a`\n\n</div>\n\n<https://x.com/`b`>')).toEqual(['`a`', '`b`']);
+    });
+});

package/dist/mdx/index.d.ts

@@ -12,6 +12,7 @@ export * from './page-style.js';
 export * from './astUtils.js';
 export * from './getS3ImageUri.js';
 export * from './getCodeStyling.js';
+export * from './getCodeRanges.js';
 export * from './replaceVariables.js';
 export * from './componentIds.js';
 export * from './islands/index.js';

package/dist/mdx/index.js

@@ -12,6 +12,7 @@ export * from './page-style.js';
 export * from './astUtils.js';
 export * from './getS3ImageUri.js';
 export * from './getCodeStyling.js';
+export * from './getCodeRanges.js';
 export * from './replaceVariables.js';
 export * from './componentIds.js';
 export * from './islands/index.js';