@astryxdesign/core 0.7.5 → 0.7.6-canary.0bd3b37

package/src/Markdown/incrementalIndentation.test.tsx

@@ -1,36 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-import {describe, expect, it} from 'vitest';
-import {
-  createIncrementalState,
-  parseMarkdown,
-  parseMarkdownIncremental,
-} from './parser';
-
-describe("a streamed document keeps its first line's indentation", () => {
-  it.each([
-    ['sibling items indented two spaces', '  - a\n  - b'],
-    ['ordered items indented one space', ' 1. a\n 2. b'],
-    ['a paragraph indented one space', ' 1'],
-    ['two paragraphs, each indented', ' a\n\n b'],
-    ['a table indented two spaces', '  | a | b |\n  | - | - |\n  | 1 | 2 |'],
-    ['a heading marker indented three spaces', '   # h'],
-  ])('gives %s the full parse, at once and streamed', (_, markdown) => {
-    const full = parseMarkdown(markdown);
-    expect(
-      parseMarkdownIncremental(markdown, createIncrementalState()),
-    ).toEqual(full);
-    const state = createIncrementalState();
-    let streamed = parseMarkdownIncremental('', state);
-    for (let end = 1; end <= markdown.length; end++) {
-      streamed = parseMarkdownIncremental(markdown.slice(0, end), state);
-    }
-    expect(streamed).toEqual(full);
-  });
-
-  it('still drops blank lines before the first block', () => {
-    expect(
-      parseMarkdownIncremental('\n\n  - a\n  - b', createIncrementalState()),
-    ).toEqual(parseMarkdown('\n\n  - a\n  - b'));
-  });
-});

package/src/Markdown/indentedFences.test.tsx

@@ -1,374 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-import {describe, expect, it} from 'vitest';
-import {
-  createIncrementalState,
-  parseMarkdown,
-  parseMarkdownAst,
-  parseMarkdownIncremental,
-} from './parser';
-
-type Json = {
-  type: string;
-  value?: string;
-  lang?: string | null;
-  children?: Json[];
-};
-
-/** The document's blocks as compact markup. */
-function blocks(markdown: string): string {
-  const show = (node: Json): string =>
-    node.type === 'text'
-      ? JSON.stringify(node.value)
-      : node.type === 'code'
-        ? `code(${node.lang ?? ''})${JSON.stringify(node.value)}`
-        : node.children == null
-          ? node.type
-          : `${node.type}[${node.children.map(show).join(', ')}]`;
-  return (parseMarkdownAst(markdown).children as unknown as Json[])
-    .map(show)
-    .join(' | ');
-}
-
-describe('a code fence may be indented up to three spaces (CommonMark 0.31 §4.5)', () => {
-  it.each([
-    [
-      'a backtick fence indented two spaces, its code losing two',
-      '  ```js\n  x\n    y\n  ```',
-      'code(js)"x\\n  y"',
-    ],
-    ['a backtick fence indented one space', ' ```\na\n ```', 'code()"a"'],
-    [
-      'a tilde fence indented three spaces',
-      '   ~~~\n   b\n   ~~~',
-      'code()"b"',
-    ],
-    [
-      'an indented closing fence',
-      '```\ncode\n  ```\nafter',
-      'code()"code" | paragraph["after"]',
-    ],
-    [
-      'an indented fence interrupting a paragraph',
-      'Text\n ```\n code\n ```',
-      'paragraph["Text"] | code()"code"',
-    ],
-    [
-      'a fence in a list item, unchanged',
-      '1. Step\n   ```bash\n   cmd\n   ```',
-      'list[listItem[paragraph["Step"], code(bash)"cmd"]]',
-    ],
-  ])('reads %s', (_, markdown, expected) => {
-    expect(blocks(markdown)).toBe(expected);
-  });
-
-  it('keeps a line indented four spaces inside the block, not as its closer', () => {
-    expect(blocks('```\na\n    ```\nb\n```')).toBe('code()"a\\n    ```\\nb"');
-  });
-
-  it('reads a fence indented four spaces as no fence', () => {
-    expect(blocks('    ```\n    x\n    ```')).not.toContain('code(');
-  });
-
-  it('collects no link definition inside an indented fence', () => {
-    expect(blocks(' ```\n[x]: /u\n ```\n\n[x]')).toBe(
-      'code()"[x]: /u" | paragraph["[x]"]',
-    );
-  });
-
-  it('streams indented fences with blank lines to the full parse at every character', () => {
-    // `d` sits at the margin after a blank line inside a fence: that blank
-    // line settles nothing, since the fence is still open.
-    const markdown =
-      'a\n\n  ```js\n  x\n\n  y\n  ```\n\nb\n\n ~~~\n\n c\n\nd\n ~~~\n';
-    for (const sourceRanges of [false, true]) {
-      const state = createIncrementalState();
-      let streamed = parseMarkdownIncremental('', state, {sourceRanges});
-      for (let end = 1; end <= markdown.length; end++) {
-        streamed = parseMarkdownIncremental(markdown.slice(0, end), state, {
-          sourceRanges,
-        });
-      }
-      expect(streamed).toEqual(parseMarkdown(markdown, {sourceRanges}));
-    }
-  });
-});
-
-/** The streamed parse of `markdown` in chunks of the given sizes, cycled. */
-function streamInChunks(
-  markdown: string,
-  sizes: ReadonlyArray<number>,
-  sourceRanges = false,
-) {
-  const state = createIncrementalState();
-  let result = parseMarkdownIncremental('', state, {sourceRanges});
-  let end = 0;
-  for (let step = 0; end < markdown.length; step++) {
-    end = Math.min(markdown.length, end + sizes[step % sizes.length]);
-    result = parseMarkdownIncremental(markdown.slice(0, end), state, {
-      sourceRanges,
-    });
-  }
-  return result;
-}
-
-const STEP_CLOSED_AT_MARGIN = [
-  '1. Install:',
-  '   ```bash',
-  '   npm i',
-  '```',
-  '',
-  '2. Run:',
-  '   ```bash',
-  '   npm test',
-  '   ```',
-  '',
-  'Done.',
-].join('\n');
-
-describe('a fence inside a list step stays the step’s', () => {
-  it('streams a step’s fence closed at the margin to the full parse at every character', () => {
-    for (const sourceRanges of [false, true]) {
-      expect(streamInChunks(STEP_CLOSED_AT_MARGIN, [1], sourceRanges)).toEqual(
-        parseMarkdown(STEP_CLOSED_AT_MARGIN, {sourceRanges}),
-      );
-    }
-  });
-
-  it('reads the margin line after a step’s fence as the opening of a fence of its own', () => {
-    expect(blocks('1. Step\n   ```\n   code\n```\nafter')).toBe(
-      'list[listItem[paragraph["Step"], code()"code"]] | code()"after"',
-    );
-  });
-
-  it('keeps a definition-shaped line inside that margin fence as code', () => {
-    expect(blocks('1. Step\n   ```\n   code\n```\n[x]: /u\n\n[x]')).toBe(
-      'list[listItem[paragraph["Step"], code()"code"]] | code()"[x]: /u\\n\\n[x]"',
-    );
-  });
-
-  it('streams 600 step-by-step answers to the full parse, closers at the margin included', () => {
-    let state = 7111;
-    const random = () => {
-      state = (state * 1103515245 + 12345) % 2147483648;
-      return state / 2147483648;
-    };
-    const pick = <T,>(choices: ReadonlyArray<T>): T =>
-      choices[Math.floor(random() * choices.length)];
-    const answer = () => {
-      const lines: string[] = [];
-      if (random() < 0.5) {
-        lines.push('Here are the steps:', '');
-      }
-      const steps = 1 + Math.floor(random() * 4);
-      for (let step = 1; step <= steps; step++) {
-        const marker = random() < 0.7 ? `${step}. ` : '- ';
-        lines.push(`${marker}Step ${step}:`);
-        if (random() < 0.3) {
-          lines.push(`${' '.repeat(marker.length)}Some detail.`);
-        }
-        if (random() < 0.4) {
-          lines.push('');
-        }
-        const indent = pick([0, 1, 2, 3, marker.length, marker.length + 1]);
-        const fence = random() < 0.85 ? '```' : '~~~';
-        lines.push(`${' '.repeat(indent)}${fence}${pick(['', 'bash', 'js'])}`);
-        const codeLines = 1 + Math.floor(random() * 3);
-        for (let line = 0; line < codeLines; line++) {
-          lines.push(
-            random() < 0.15
-              ? ''
-              : `${' '.repeat(pick([0, indent, indent + 2]))}code ${line}`,
-          );
-        }
-        const closer = random();
-        if (closer < 0.4) {
-          lines.push(fence);
-        } else if (closer < 0.9) {
-          lines.push(`${' '.repeat(indent)}${fence}`);
-        }
-        if (random() < 0.6) {
-          lines.push('');
-        }
-      }
-      if (random() < 0.5) {
-        lines.push('That is all.');
-      }
-      // A fence left open at the very end with a newline after it keeps a
-      // final empty line in the full parse only — a separate difference.
-      return lines.join('\n').trimEnd();
-    };
-    const diverged: string[] = [];
-    for (let round = 0; round < 600; round++) {
-      const markdown = answer();
-      const sizes = [
-        1 + Math.floor(random() * 12),
-        1 + Math.floor(random() * 5),
-      ];
-      const full = parseMarkdown(markdown);
-      if (
-        JSON.stringify(streamInChunks(markdown, sizes)) !== JSON.stringify(full)
-      ) {
-        diverged.push(markdown);
-      }
-    }
-    expect(diverged).toEqual([]);
-  });
-});
-
-describe('fences around list steps, streamed', () => {
-  it('streams 600 varied answers to the full parse: sub-steps, blank lines in fences, text after a step’s fence', () => {
-    let state = 424242;
-    const random = () => {
-      state = (state * 1103515245 + 12345) % 2147483648;
-      return state / 2147483648;
-    };
-    const pick = <T,>(choices: ReadonlyArray<T>): T =>
-      choices[Math.floor(random() * choices.length)];
-    const pushFence = (indent: number, lines: string[]) => {
-      const fence = pick(['```', '```', '~~~', '````']);
-      lines.push(`${' '.repeat(indent)}${fence}${pick(['', 'bash', ' py'])}`);
-      const codeLines = Math.floor(random() * 4);
-      for (let line = 0; line < codeLines; line++) {
-        lines.push(
-          random() < 0.2
-            ? ''
-            : `${' '.repeat(pick([0, indent, indent + 1, indent + 4]))}${pick(['code', '[x]: /u', '- item', '# title', '> q'])} ${line}`,
-        );
-      }
-      const closer = random();
-      if (closer < 0.35) {
-        lines.push(fence);
-      } else if (closer < 0.75) {
-        lines.push(`${' '.repeat(indent)}${fence}`);
-      } else if (closer < 0.85) {
-        lines.push(`${' '.repeat(indent)}${fence}js`);
-      } else if (closer < 0.9) {
-        lines.push(`${' '.repeat(indent + 1)}${fence}  `);
-      }
-    };
-    const answer = () => {
-      const lines: string[] = [];
-      if (random() < 0.4) {
-        lines.push(pick(['Steps:', 'Here you go']));
-        if (random() < 0.6) {
-          lines.push('');
-        }
-      }
-      // Every list at the margin with a `-` bullet, as lines escaping a step's
-      // fence are: two lists of different styles, a blank line apart, are a
-      // separate case of the settled-list merge.
-      const bullet = pick(['- ', '-   ']);
-      const delimiter = pick(['.', ')']);
-      const base = 0;
-      let number = pick([1, 1, 2]);
-      const steps = 1 + Math.floor(random() * 5);
-      for (let step = 0; step < steps; step++) {
-        const marker = random() < 0.65 ? `${number++}${delimiter} ` : bullet;
-        lines.push(`${' '.repeat(base)}${marker}Step ${step}`);
-        const content = base + marker.length;
-        const parts = Math.floor(random() * 3);
-        for (let part = 0; part < parts; part++) {
-          const roll = random();
-          if (roll < 0.3) {
-            lines.push('');
-          }
-          // A sub-step directly under its step: placed after the step has
-          // ended, it would start a list of its own at another indentation.
-          if (roll < 0.15 && part === 0) {
-            lines.push(`${' '.repeat(content)}- sub ${part}`);
-          } else if (roll < 0.45) {
-            pushFence(pick([0, 1, 2, 3, content, content + 1]), lines);
-          } else if (roll < 0.6) {
-            lines.push(
-              pick(['lazy text', `${' '.repeat(content)}more`, 'Then:']),
-            );
-          } else if (roll < 0.7) {
-            lines.push(`${' '.repeat(pick([0, content]))}# Heading`);
-          }
-        }
-        if (random() < 0.5) {
-          lines.push('');
-        }
-        if (random() < 0.2) {
-          lines.push('Between steps.');
-          if (random() < 0.5) {
-            lines.push('');
-          }
-        }
-      }
-      if (random() < 0.3) {
-        pushFence(pick([0, 1, 2, 3]), lines);
-      }
-      if (random() < 0.4) {
-        lines.push('That is all.');
-      }
-      return lines.join('\n').trimEnd();
-    };
-    const diverged: string[] = [];
-    for (let round = 0; round < 600; round++) {
-      const markdown = answer();
-      const sizes =
-        round % 10 === 0
-          ? [1]
-          : [1 + Math.floor(random() * 12), 1 + Math.floor(random() * 5)];
-      if (
-        JSON.stringify(streamInChunks(markdown, sizes)) !==
-        JSON.stringify(parseMarkdown(markdown))
-      ) {
-        diverged.push(markdown);
-      }
-    }
-    expect(diverged).toEqual([]);
-  });
-});
-
-describe('a closing fence has only spaces or tabs after it (CommonMark 0.31 §4.5)', () => {
-  it.each([
-    [
-      'a backtick line with an info string',
-      '```\na\n   ```js\nb\n```',
-      'code()"a\\n   ```js\\nb"',
-    ],
-    [
-      'a tilde line with an info string',
-      '~~~\na\n   ~~~ note\nb\n~~~',
-      'code()"a\\n   ~~~ note\\nb"',
-    ],
-    [
-      'a closer followed by spaces and a tab',
-      '```\na\n```  \t\nb',
-      'code()"a" | paragraph["b"]',
-    ],
-  ])(
-    'keeps %s inside the open block, or closes on spaces',
-    (_, markdown, expected) => {
-      expect(blocks(markdown)).toBe(expected);
-    },
-  );
-
-  const STEP_TWO_OPENS = [
-    '1. Step one',
-    '   ```bash',
-    '   cmd',
-    '```',
-    '2. Step two',
-    '   ```js',
-    '   x',
-    '   ```',
-  ].join('\n');
-
-  it('reads step 1 closed at the margin, then step 2 opening, as CommonMark does', () => {
-    expect(blocks(STEP_TWO_OPENS)).toBe(
-      'list[listItem[paragraph["Step one"], code(bash)"cmd"]] | code()"2. Step two\\n   ```js\\n   x"',
-    );
-  });
-
-  it('streams that answer to the full parse at every character', () => {
-    for (const sourceRanges of [false, true]) {
-      expect(streamInChunks(STEP_TWO_OPENS, [1], sourceRanges)).toEqual(
-        parseMarkdown(STEP_TWO_OPENS, {sourceRanges}),
-      );
-    }
-  });
-});

package/src/Markdown/indentedTables.test.tsx

@@ -1,53 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-import {describe, expect, it} from 'vitest';
-import {
-  createIncrementalState,
-  parseMarkdown,
-  parseMarkdownAst,
-  parseMarkdownIncremental,
-} from './parser';
-
-type Json = {type: string; value?: string; children?: Json[]};
-
-/** Each table row's cell texts. */
-function tableRows(markdown: string): string[][] {
-  const text = (node: Json): string =>
-    node.value ?? (node.children ?? []).map(text).join('');
-  const table = (parseMarkdownAst(markdown).children as unknown as Json[]).find(
-    node => node.type === 'table',
-  );
-  return (table?.children ?? []).map(row => (row.children ?? []).map(text));
-}
-
-describe("a table row's indentation opens no cell", () => {
-  it.each([
-    ['indented two spaces', '  | a | b |\n  | - | - |\n  | 1 | 2 |'],
-    ['indented three spaces', '   | a | b |\n   | - | - |\n   | 1 | 2 |'],
-    ['indented with a tab', '\t| a | b |\n\t| - | - |\n\t| 1 | 2 |'],
-    ['indented without outer pipes', '  a | b\n  - | -\n  1 | 2'],
-    ['at the margin, unchanged', '| a | b |\n| - | - |\n| 1 | 2 |'],
-  ])('reads a table %s as two columns', (_, markdown) => {
-    expect(tableRows(markdown)).toEqual([
-      ['a', 'b'],
-      ['1', '2'],
-    ]);
-  });
-
-  it('keeps an empty first cell written inside the pipes', () => {
-    expect(tableRows('  |   | b |\n  | - | - |\n  |   | 2 |')).toEqual([
-      ['', 'b'],
-      ['', '2'],
-    ]);
-  });
-
-  it('streams an indented table to the full parse at every character', () => {
-    const markdown = 'Intro\n\n  | a | b |\n  | - | - |\n  | 1 | 2 |\n\nAfter';
-    const state = createIncrementalState();
-    let streamed = parseMarkdownIncremental('', state);
-    for (let end = 1; end <= markdown.length; end++) {
-      streamed = parseMarkdownIncremental(markdown.slice(0, end), state);
-    }
-    expect(streamed).toEqual(parseMarkdown(markdown));
-  });
-});

package/src/Markdown/linkBrackets.test.tsx

@@ -1,116 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-import {describe, expect, it} from 'vitest';
-import {parseInlineAst, parseMarkdownAst} from './parser';
-
-type Json = {
-  type: string;
-  url?: string;
-  alt?: string;
-  value?: string;
-  children?: Json[];
-};
-
-/** Inline nodes as compact markup: links as `<a url>…</a>`. */
-function show(nodes: ReadonlyArray<Json>): string {
-  return nodes
-    .map(node => {
-      switch (node.type) {
-        case 'text':
-          return node.value;
-        case 'inlineCode':
-          return `\`${node.value}\``;
-        case 'link':
-          return `<a ${node.url}>${show(node.children ?? [])}</a>`;
-        case 'image':
-          return `<img ${node.url}>`;
-        default:
-          return `<${node.type}>${show(node.children ?? [])}</${node.type}>`;
-      }
-    })
-    .join('');
-}
-
-const inline = (markdown: string): string =>
-  show(parseInlineAst(markdown) as unknown as Json[]);
-
-/** The first paragraph of a document, as compact markup. */
-const paragraph = (markdown: string): string =>
-  show(
-    (parseMarkdownAst(markdown).children as unknown as Json[])[0].children ??
-      [],
-  );
-
-describe('link text brackets (CommonMark 0.31 §6.3)', () => {
-  it.each([
-    [
-      'link text may hold balanced brackets',
-      '[a [b] c](u)',
-      '<a u>a [b] c</a>',
-    ],
-    ['a bracket pair can be the whole text', '[[b]](u)', '<a u>[b]</a>'],
-    ['the innermost opener makes the link', '[a [b](u)', '[a <a u>b</a>'],
-    [
-      'a link inside link text wins; the outer brackets stay text',
-      '[a [b](u) c](v)',
-      '[a <a u>b</a> c](v)',
-    ],
-    ['an image may sit in link text', '[![i](img)](u)', '<a u><img img></a>'],
-    ['an image may hold a link', '![a [b](u) c](v) d', '<img v> d'],
-    [
-      'a refused inner link still keeps the outer brackets text',
-      '[a [b](javascript:x) c](v)',
-      '[a [b](javascript:x) c](v)',
-    ],
-    [
-      'emphasis may cross brackets that stay text',
-      '*[a [b](u) c*](v)',
-      '<emphasis>[a <a u>b</a> c</emphasis>](v)',
-    ],
-    ['an unmatched closer is text', '[a]b](u)', '[a]b](u)'],
-    [
-      'brackets in a destination pair with nothing',
-      '[a](b]c) [d](e)',
-      '<a b]c>a</a> <a e>d</a>',
-    ],
-    ['an escaped bracket is text', '[a\\]b](u)', '<a u>a]b</a>'],
-    ['a code span hides its brackets', '[`]`](u)', '<a u>`]`</a>'],
-  ])('%s: %j', (_, markdown, expected) => {
-    expect(inline(markdown)).toBe(expected);
-  });
-
-  it('pairs reference links the same way', () => {
-    const definitions = '\n\n[bar]: /bar\n[y]: /y';
-    expect(paragraph(`[foo [bar]]${definitions}`)).toBe(
-      '[foo <a /bar>bar</a>]',
-    );
-    expect(paragraph(`[x][y]${definitions}`)).toBe('<a /y>x</a>');
-    expect(paragraph(`[a [bar] c](u)${definitions}`)).toBe(
-      '[a <a /bar>bar</a> c](u)',
-    );
-  });
-
-  it.each([
-    [
-      'many openers around one link',
-      `${'['.repeat(20_000)}[a](u)${'](v)'.repeat(20_000)}`,
-    ],
-    ['many links inside link text', '[a [b](u) '.repeat(10_000)],
-    [
-      'deeply balanced brackets',
-      `${'['.repeat(20_000)}a${']'.repeat(20_000)}(u)`,
-    ],
-    ['nested images', `${'!['.repeat(20_000)}a${'](u)'.repeat(20_000)}`],
-  ])('pairs %s in linear time', (_, markdown) => {
-    parseInlineAst(markdown);
-    let fastest = Number.POSITIVE_INFINITY;
-    for (let round = 0; round < 3; round++) {
-      const started = performance.now();
-      parseInlineAst(markdown);
-      fastest = Math.min(fastest, performance.now() - started);
-    }
-    // Alone, each takes 10–140 ms; the budget leaves room for a loaded
-    // test machine.
-    expect(fastest).toBeLessThan(2000);
-  });
-});

package/src/Markdown/linkDestinationLinear.test.tsx

@@ -1,54 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-import {describe, expect, it} from 'vitest';
-import {parseInlineAst} from './parser';
-
-type Json = {type: string; url?: string; value?: string; children?: Json[]};
-
-/** Each link's or image's URL, in order. */
-function urls(markdown: string): string[] {
-  const found: string[] = [];
-  const visit = (node: Json) => {
-    if (node.type === 'link' || node.type === 'image') {
-      found.push(node.url ?? '');
-    }
-    (node.children ?? []).forEach(visit);
-  };
-  (parseInlineAst(markdown) as unknown as Json[]).forEach(visit);
-  return found;
-}
-
-/** The fastest of three parses of `markdown`, in milliseconds. */
-function parseTime(markdown: string): number {
-  parseInlineAst(markdown);
-  let fastest = Number.POSITIVE_INFINITY;
-  for (let round = 0; round < 3; round++) {
-    const started = performance.now();
-    parseInlineAst(markdown);
-    fastest = Math.min(fastest, performance.now() - started);
-  }
-  return fastest;
-}
-
-describe('link destinations end where their parentheses balance', () => {
-  it.each([
-    ['[a](b(c)d)', ['b(c)d']],
-    ['[a](b((c))d) and [e](f)', ['b((c))d', 'f']],
-    ['[a](b\\)c)', ['b)c']],
-    ['![i](a(b)c)', ['a(b)c']],
-    ['[a](b(c) and [e](f)', ['f']],
-  ])('reads %j', (markdown, expected) => {
-    expect(urls(markdown)).toEqual(expected);
-  });
-
-  it.each([
-    ['links with unclosed destinations', '[a](b '.repeat(20_000)],
-    ['images with unclosed destinations', '![a](b '.repeat(20_000)],
-    ['unclosed nested parentheses', '[a](('.repeat(20_000)],
-    ['one closing parenthesis at the end', `${'[a]('.repeat(20_000)})`],
-  ])('reads %s in linear time', (_, markdown) => {
-    // Alone, each takes about 10 ms; the budget leaves room for a loaded
-    // test machine. Searching every destination to the end took 4 to 13 s.
-    expect(parseTime(markdown)).toBeLessThan(1000);
-  });
-});