debian-mirror-gitlab/spec/frontend/content_editor/remark_markdown_processing_spec.js

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

1014 lines
28 KiB
JavaScript
Raw Normal View History

2022-07-16 23:28:13 +05:30
import Bold from '~/content_editor/extensions/bold';
import Blockquote from '~/content_editor/extensions/blockquote';
import BulletList from '~/content_editor/extensions/bullet_list';
import Code from '~/content_editor/extensions/code';
import CodeBlockHighlight from '~/content_editor/extensions/code_block_highlight';
2022-07-23 23:45:48 +05:30
import FootnoteDefinition from '~/content_editor/extensions/footnote_definition';
import FootnoteReference from '~/content_editor/extensions/footnote_reference';
2022-07-16 23:28:13 +05:30
import HardBreak from '~/content_editor/extensions/hard_break';
import Heading from '~/content_editor/extensions/heading';
import HorizontalRule from '~/content_editor/extensions/horizontal_rule';
import Image from '~/content_editor/extensions/image';
import Italic from '~/content_editor/extensions/italic';
import Link from '~/content_editor/extensions/link';
import ListItem from '~/content_editor/extensions/list_item';
import OrderedList from '~/content_editor/extensions/ordered_list';
2022-07-23 23:45:48 +05:30
import Paragraph from '~/content_editor/extensions/paragraph';
2022-07-16 23:28:13 +05:30
import Sourcemap from '~/content_editor/extensions/sourcemap';
2022-07-23 23:45:48 +05:30
import Strike from '~/content_editor/extensions/strike';
import Table from '~/content_editor/extensions/table';
import TableHeader from '~/content_editor/extensions/table_header';
import TableRow from '~/content_editor/extensions/table_row';
import TableCell from '~/content_editor/extensions/table_cell';
import TaskList from '~/content_editor/extensions/task_list';
import TaskItem from '~/content_editor/extensions/task_item';
2022-07-16 23:28:13 +05:30
import remarkMarkdownDeserializer from '~/content_editor/services/remark_markdown_deserializer';
import markdownSerializer from '~/content_editor/services/markdown_serializer';
2022-07-23 23:45:48 +05:30
import { createTestEditor, createDocBuilder } from './test_utils';
2022-07-16 23:28:13 +05:30
const tiptapEditor = createTestEditor({
extensions: [
Blockquote,
Bold,
BulletList,
Code,
CodeBlockHighlight,
2022-07-23 23:45:48 +05:30
FootnoteDefinition,
FootnoteReference,
2022-07-16 23:28:13 +05:30
HardBreak,
Heading,
HorizontalRule,
Image,
Italic,
Link,
ListItem,
OrderedList,
Sourcemap,
2022-07-23 23:45:48 +05:30
Strike,
Table,
TableRow,
TableHeader,
TableCell,
TaskList,
TaskItem,
2022-07-16 23:28:13 +05:30
],
});
2022-07-23 23:45:48 +05:30
const {
builders: {
doc,
paragraph,
bold,
blockquote,
bulletList,
code,
codeBlock,
footnoteDefinition,
footnoteReference,
hardBreak,
heading,
horizontalRule,
image,
italic,
link,
listItem,
orderedList,
strike,
table,
tableRow,
tableHeader,
tableCell,
taskItem,
taskList,
},
} = createDocBuilder({
tiptapEditor,
names: {
blockquote: { nodeType: Blockquote.name },
bold: { markType: Bold.name },
bulletList: { nodeType: BulletList.name },
code: { markType: Code.name },
codeBlock: { nodeType: CodeBlockHighlight.name },
footnoteDefinition: { nodeType: FootnoteDefinition.name },
footnoteReference: { nodeType: FootnoteReference.name },
hardBreak: { nodeType: HardBreak.name },
heading: { nodeType: Heading.name },
horizontalRule: { nodeType: HorizontalRule.name },
image: { nodeType: Image.name },
italic: { nodeType: Italic.name },
link: { markType: Link.name },
listItem: { nodeType: ListItem.name },
orderedList: { nodeType: OrderedList.name },
paragraph: { nodeType: Paragraph.name },
strike: { nodeType: Strike.name },
table: { nodeType: Table.name },
tableCell: { nodeType: TableCell.name },
tableHeader: { nodeType: TableHeader.name },
tableRow: { nodeType: TableRow.name },
taskItem: { nodeType: TaskItem.name },
taskList: { nodeType: TaskList.name },
},
});
2022-07-16 23:28:13 +05:30
describe('Client side Markdown processing', () => {
const deserialize = async (content) => {
const { document } = await remarkMarkdownDeserializer().deserialize({
schema: tiptapEditor.schema,
content,
});
return document;
};
const serialize = (document) =>
markdownSerializer({}).serialize({
doc: document,
pristineDoc: document,
});
2022-07-23 23:45:48 +05:30
const sourceAttrs = (sourceMapKey, sourceMarkdown) => ({
sourceMapKey,
sourceMarkdown,
});
const examples = [
2022-07-16 23:28:13 +05:30
{
markdown: '__bold text__',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:13', '__bold text__'),
bold(sourceAttrs('0:13', '__bold text__'), 'bold text'),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '**bold text**',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:13', '**bold text**'),
bold(sourceAttrs('0:13', '**bold text**'), 'bold text'),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '<strong>bold text</strong>',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:26', '<strong>bold text</strong>'),
bold(sourceAttrs('0:26', '<strong>bold text</strong>'), 'bold text'),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '<b>bold text</b>',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:16', '<b>bold text</b>'),
bold(sourceAttrs('0:16', '<b>bold text</b>'), 'bold text'),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '_italic text_',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:13', '_italic text_'),
italic(sourceAttrs('0:13', '_italic text_'), 'italic text'),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '*italic text*',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:13', '*italic text*'),
italic(sourceAttrs('0:13', '*italic text*'), 'italic text'),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '<em>italic text</em>',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:20', '<em>italic text</em>'),
italic(sourceAttrs('0:20', '<em>italic text</em>'), 'italic text'),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '<i>italic text</i>',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:18', '<i>italic text</i>'),
italic(sourceAttrs('0:18', '<i>italic text</i>'), 'italic text'),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '`inline code`',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:13', '`inline code`'),
code(sourceAttrs('0:13', '`inline code`'), 'inline code'),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '**`inline code bold`**',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:22', '**`inline code bold`**'),
bold(
sourceAttrs('0:22', '**`inline code bold`**'),
code(sourceAttrs('2:20', '`inline code bold`'), 'inline code bold'),
),
),
),
},
{
markdown: '_`inline code italics`_',
expectedDoc: doc(
paragraph(
sourceAttrs('0:23', '_`inline code italics`_'),
italic(
sourceAttrs('0:23', '_`inline code italics`_'),
code(sourceAttrs('1:22', '`inline code italics`'), 'inline code italics'),
),
),
),
},
{
markdown: `
<i class="foo">
*bar*
</i>
`,
expectedDoc: doc(
paragraph(
sourceAttrs('0:28', '<i class="foo">\n *bar*\n</i>'),
italic(sourceAttrs('0:28', '<i class="foo">\n *bar*\n</i>'), '\n *bar*\n'),
),
),
},
{
markdown: `
<img src="bar" alt="foo" />
`,
expectedDoc: doc(
paragraph(
sourceAttrs('0:27', '<img src="bar" alt="foo" />'),
image({ ...sourceAttrs('0:27', '<img src="bar" alt="foo" />'), alt: 'foo', src: 'bar' }),
),
),
2022-07-16 23:28:13 +05:30
},
{
2022-07-23 23:45:48 +05:30
markdown: `
- List item 1
<img src="bar" alt="foo" />
`,
expectedDoc: doc(
bulletList(
sourceAttrs('0:13', '- List item 1'),
listItem(
sourceAttrs('0:13', '- List item 1'),
paragraph(sourceAttrs('2:13', 'List item 1'), 'List item 1'),
),
),
paragraph(
sourceAttrs('15:42', '<img src="bar" alt="foo" />'),
image({ ...sourceAttrs('15:42', '<img src="bar" alt="foo" />'), alt: 'foo', src: 'bar' }),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '[GitLab](https://gitlab.com "Go to GitLab")',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:43', '[GitLab](https://gitlab.com "Go to GitLab")'),
link(
{
...sourceAttrs('0:43', '[GitLab](https://gitlab.com "Go to GitLab")'),
href: 'https://gitlab.com',
title: 'Go to GitLab',
},
'GitLab',
),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '**[GitLab](https://gitlab.com "Go to GitLab")**',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:47', '**[GitLab](https://gitlab.com "Go to GitLab")**'),
bold(
sourceAttrs('0:47', '**[GitLab](https://gitlab.com "Go to GitLab")**'),
link(
{
...sourceAttrs('2:45', '[GitLab](https://gitlab.com "Go to GitLab")'),
href: 'https://gitlab.com',
title: 'Go to GitLab',
},
'GitLab',
),
),
),
),
},
{
markdown: 'www.commonmark.org',
expectedDoc: doc(
paragraph(
sourceAttrs('0:18', 'www.commonmark.org'),
link(
{
...sourceAttrs('0:18', 'www.commonmark.org'),
href: 'http://www.commonmark.org',
},
'www.commonmark.org',
),
),
),
},
{
markdown: 'Visit www.commonmark.org/help for more information.',
expectedDoc: doc(
paragraph(
sourceAttrs('0:51', 'Visit www.commonmark.org/help for more information.'),
'Visit ',
link(
{
...sourceAttrs('6:29', 'www.commonmark.org/help'),
href: 'http://www.commonmark.org/help',
},
'www.commonmark.org/help',
),
' for more information.',
),
),
},
{
markdown: 'hello@mail+xyz.example isnt valid, but hello+xyz@mail.example is.',
expectedDoc: doc(
paragraph(
sourceAttrs('0:66', 'hello@mail+xyz.example isnt valid, but hello+xyz@mail.example is.'),
'hello@mail+xyz.example isnt valid, but ',
link(
{
...sourceAttrs('40:62', 'hello+xyz@mail.example'),
href: 'mailto:hello+xyz@mail.example',
},
'hello+xyz@mail.example',
),
' is.',
),
),
},
{
markdown: '[https://gitlab.com>',
expectedDoc: doc(
paragraph(
sourceAttrs('0:20', '[https://gitlab.com>'),
'[',
link(
{
...sourceAttrs(),
href: 'https://gitlab.com',
},
'https://gitlab.com',
),
'>',
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
This is a paragraph with a\\
hard line break`,
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:43', 'This is a paragraph with a\\\nhard line break'),
'This is a paragraph with a',
hardBreak(sourceAttrs('26:28', '\\\n')),
'\nhard line break',
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '![GitLab Logo](https://gitlab.com/logo.png "GitLab Logo")',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
paragraph(
sourceAttrs('0:57', '![GitLab Logo](https://gitlab.com/logo.png "GitLab Logo")'),
image({
...sourceAttrs('0:57', '![GitLab Logo](https://gitlab.com/logo.png "GitLab Logo")'),
alt: 'GitLab Logo',
src: 'https://gitlab.com/logo.png',
title: 'GitLab Logo',
}),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '---',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(horizontalRule(sourceAttrs('0:3', '---'))),
2022-07-16 23:28:13 +05:30
},
{
markdown: '***',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(horizontalRule(sourceAttrs('0:3', '***'))),
2022-07-16 23:28:13 +05:30
},
{
markdown: '___',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(horizontalRule(sourceAttrs('0:3', '___'))),
2022-07-16 23:28:13 +05:30
},
{
markdown: '<hr>',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(horizontalRule(sourceAttrs('0:4', '<hr>'))),
2022-07-16 23:28:13 +05:30
},
{
markdown: '# Heading 1',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(heading({ ...sourceAttrs('0:11', '# Heading 1'), level: 1 }, 'Heading 1')),
2022-07-16 23:28:13 +05:30
},
{
markdown: '## Heading 2',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(heading({ ...sourceAttrs('0:12', '## Heading 2'), level: 2 }, 'Heading 2')),
2022-07-16 23:28:13 +05:30
},
{
markdown: '### Heading 3',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(heading({ ...sourceAttrs('0:13', '### Heading 3'), level: 3 }, 'Heading 3')),
2022-07-16 23:28:13 +05:30
},
{
markdown: '#### Heading 4',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
heading({ ...sourceAttrs('0:14', '#### Heading 4'), level: 4 }, 'Heading 4'),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '##### Heading 5',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
heading({ ...sourceAttrs('0:15', '##### Heading 5'), level: 5 }, 'Heading 5'),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: '###### Heading 6',
2022-07-23 23:45:48 +05:30
expectedDoc: doc(
heading({ ...sourceAttrs('0:16', '###### Heading 6'), level: 6 }, 'Heading 6'),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
Heading
one
======
`,
expectedDoc: doc(
heading({ ...sourceAttrs('0:18', 'Heading\none\n======'), level: 1 }, 'Heading\none'),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
Heading
two
-------
`,
expectedDoc: doc(
heading({ ...sourceAttrs('0:19', 'Heading\ntwo\n-------'), level: 2 }, 'Heading\ntwo'),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
- List item 1
- List item 2
`,
expectedDoc: doc(
bulletList(
sourceAttrs('0:27', '- List item 1\n- List item 2'),
listItem(
sourceAttrs('0:13', '- List item 1'),
paragraph(sourceAttrs('2:13', 'List item 1'), 'List item 1'),
),
listItem(
sourceAttrs('14:27', '- List item 2'),
paragraph(sourceAttrs('16:27', 'List item 2'), 'List item 2'),
),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
* List item 1
* List item 2
`,
expectedDoc: doc(
bulletList(
sourceAttrs('0:27', '* List item 1\n* List item 2'),
listItem(
sourceAttrs('0:13', '* List item 1'),
paragraph(sourceAttrs('2:13', 'List item 1'), 'List item 1'),
),
listItem(
sourceAttrs('14:27', '* List item 2'),
paragraph(sourceAttrs('16:27', 'List item 2'), 'List item 2'),
),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
+ List item 1
+ List item 2
`,
expectedDoc: doc(
bulletList(
sourceAttrs('0:27', '+ List item 1\n+ List item 2'),
listItem(
sourceAttrs('0:13', '+ List item 1'),
paragraph(sourceAttrs('2:13', 'List item 1'), 'List item 1'),
),
listItem(
sourceAttrs('14:27', '+ List item 2'),
paragraph(sourceAttrs('16:27', 'List item 2'), 'List item 2'),
),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
1. List item 1
1. List item 2
`,
expectedDoc: doc(
orderedList(
sourceAttrs('0:29', '1. List item 1\n1. List item 2'),
listItem(
sourceAttrs('0:14', '1. List item 1'),
paragraph(sourceAttrs('3:14', 'List item 1'), 'List item 1'),
),
listItem(
sourceAttrs('15:29', '1. List item 2'),
paragraph(sourceAttrs('18:29', 'List item 2'), 'List item 2'),
),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
1. List item 1
2. List item 2
`,
expectedDoc: doc(
orderedList(
sourceAttrs('0:29', '1. List item 1\n2. List item 2'),
listItem(
sourceAttrs('0:14', '1. List item 1'),
paragraph(sourceAttrs('3:14', 'List item 1'), 'List item 1'),
),
listItem(
sourceAttrs('15:29', '2. List item 2'),
paragraph(sourceAttrs('18:29', 'List item 2'), 'List item 2'),
),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
1) List item 1
2) List item 2
`,
expectedDoc: doc(
orderedList(
sourceAttrs('0:29', '1) List item 1\n2) List item 2'),
listItem(
sourceAttrs('0:14', '1) List item 1'),
paragraph(sourceAttrs('3:14', 'List item 1'), 'List item 1'),
),
listItem(
sourceAttrs('15:29', '2) List item 2'),
paragraph(sourceAttrs('18:29', 'List item 2'), 'List item 2'),
),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
- List item 1
- Sub list item 1
`,
expectedDoc: doc(
bulletList(
sourceAttrs('0:33', '- List item 1\n - Sub list item 1'),
listItem(
sourceAttrs('0:33', '- List item 1\n - Sub list item 1'),
paragraph(sourceAttrs('2:13', 'List item 1'), 'List item 1'),
bulletList(
sourceAttrs('16:33', '- Sub list item 1'),
listItem(
sourceAttrs('16:33', '- Sub list item 1'),
paragraph(sourceAttrs('18:33', 'Sub list item 1'), 'Sub list item 1'),
),
),
),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
- List item 1 paragraph 1
2022-07-16 23:28:13 +05:30
2022-07-23 23:45:48 +05:30
List item 1 paragraph 2
- List item 2
`,
expectedDoc: doc(
bulletList(
sourceAttrs(
'0:66',
'- List item 1 paragraph 1\n\n List item 1 paragraph 2\n- List item 2',
),
listItem(
sourceAttrs('0:52', '- List item 1 paragraph 1\n\n List item 1 paragraph 2'),
paragraph(sourceAttrs('2:25', 'List item 1 paragraph 1'), 'List item 1 paragraph 1'),
paragraph(sourceAttrs('29:52', 'List item 1 paragraph 2'), 'List item 1 paragraph 2'),
),
listItem(
sourceAttrs('53:66', '- List item 2'),
paragraph(sourceAttrs('55:66', 'List item 2'), 'List item 2'),
),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
- List item with an image ![bar](foo.png)
`,
expectedDoc: doc(
bulletList(
sourceAttrs('0:41', '- List item with an image ![bar](foo.png)'),
listItem(
sourceAttrs('0:41', '- List item with an image ![bar](foo.png)'),
paragraph(
sourceAttrs('2:41', 'List item with an image ![bar](foo.png)'),
'List item with an image',
image({ ...sourceAttrs('26:41', '![bar](foo.png)'), alt: 'bar', src: 'foo.png' }),
),
),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
> This is a blockquote
`,
expectedDoc: doc(
blockquote(
sourceAttrs('0:22', '> This is a blockquote'),
paragraph(sourceAttrs('2:22', 'This is a blockquote'), 'This is a blockquote'),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
> - List item 1
> - List item 2
`,
expectedDoc: doc(
blockquote(
sourceAttrs('0:31', '> - List item 1\n> - List item 2'),
bulletList(
sourceAttrs('2:31', '- List item 1\n> - List item 2'),
listItem(
sourceAttrs('2:15', '- List item 1'),
paragraph(sourceAttrs('4:15', 'List item 1'), 'List item 1'),
),
listItem(
sourceAttrs('18:31', '- List item 2'),
paragraph(sourceAttrs('20:31', 'List item 2'), 'List item 2'),
),
),
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
code block
const fn = () => 'GitLab';
`,
expectedDoc: doc(
paragraph(sourceAttrs('0:10', 'code block'), 'code block'),
codeBlock(
{
...sourceAttrs('12:42', " const fn = () => 'GitLab';"),
class: 'code highlight',
language: null,
},
"const fn = () => 'GitLab';",
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
\`\`\`javascript
const fn = () => 'GitLab';
\`\`\`\
`,
expectedDoc: doc(
codeBlock(
{
...sourceAttrs('0:44', "```javascript\nconst fn = () => 'GitLab';\n```"),
class: 'code highlight',
language: 'javascript',
},
"const fn = () => 'GitLab';",
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
~~~javascript
const fn = () => 'GitLab';
~~~
`,
expectedDoc: doc(
codeBlock(
{
...sourceAttrs('0:44', "~~~javascript\nconst fn = () => 'GitLab';\n~~~"),
class: 'code highlight',
language: 'javascript',
},
"const fn = () => 'GitLab';",
),
),
2022-07-16 23:28:13 +05:30
},
{
markdown: `
2022-07-23 23:45:48 +05:30
\`\`\`
\`\`\`\
`,
expectedDoc: doc(
codeBlock(
{
...sourceAttrs('0:7', '```\n```'),
class: 'code highlight',
language: null,
},
'',
),
),
},
{
markdown: `
\`\`\`javascript
const fn = () => 'GitLab';
2022-07-16 23:28:13 +05:30
2022-07-23 23:45:48 +05:30
\`\`\`\
`,
expectedDoc: doc(
codeBlock(
{
...sourceAttrs('0:45', "```javascript\nconst fn = () => 'GitLab';\n\n```"),
class: 'code highlight',
language: 'javascript',
},
"const fn = () => 'GitLab';\n",
),
),
},
{
markdown: '~~Strikedthrough text~~',
expectedDoc: doc(
paragraph(
sourceAttrs('0:23', '~~Strikedthrough text~~'),
strike(sourceAttrs('0:23', '~~Strikedthrough text~~'), 'Strikedthrough text'),
),
),
},
{
markdown: '<del>Strikedthrough text</del>',
expectedDoc: doc(
paragraph(
sourceAttrs('0:30', '<del>Strikedthrough text</del>'),
strike(sourceAttrs('0:30', '<del>Strikedthrough text</del>'), 'Strikedthrough text'),
),
),
},
{
markdown: '<strike>Strikedthrough text</strike>',
expectedDoc: doc(
paragraph(
sourceAttrs('0:36', '<strike>Strikedthrough text</strike>'),
strike(
sourceAttrs('0:36', '<strike>Strikedthrough text</strike>'),
'Strikedthrough text',
),
),
),
},
{
markdown: '<s>Strikedthrough text</s>',
expectedDoc: doc(
paragraph(
sourceAttrs('0:26', '<s>Strikedthrough text</s>'),
strike(sourceAttrs('0:26', '<s>Strikedthrough text</s>'), 'Strikedthrough text'),
),
),
2022-07-16 23:28:13 +05:30
},
2022-07-23 23:45:48 +05:30
{
markdown: `
- [ ] task list item 1
- [ ] task list item 2
`,
expectedDoc: doc(
taskList(
{
numeric: false,
...sourceAttrs('0:45', '- [ ] task list item 1\n- [ ] task list item 2'),
},
taskItem(
{
checked: false,
...sourceAttrs('0:22', '- [ ] task list item 1'),
},
paragraph(sourceAttrs('6:22', 'task list item 1'), 'task list item 1'),
),
taskItem(
{
checked: false,
...sourceAttrs('23:45', '- [ ] task list item 2'),
},
paragraph(sourceAttrs('29:45', 'task list item 2'), 'task list item 2'),
),
),
),
},
{
markdown: `
- [x] task list item 1
- [x] task list item 2
`,
expectedDoc: doc(
taskList(
{
numeric: false,
...sourceAttrs('0:45', '- [x] task list item 1\n- [x] task list item 2'),
},
taskItem(
{
checked: true,
...sourceAttrs('0:22', '- [x] task list item 1'),
},
paragraph(sourceAttrs('6:22', 'task list item 1'), 'task list item 1'),
),
taskItem(
{
checked: true,
...sourceAttrs('23:45', '- [x] task list item 2'),
},
paragraph(sourceAttrs('29:45', 'task list item 2'), 'task list item 2'),
),
),
),
},
{
markdown: `
1. [ ] task list item 1
2. [ ] task list item 2
`,
expectedDoc: doc(
taskList(
{
numeric: true,
...sourceAttrs('0:47', '1. [ ] task list item 1\n2. [ ] task list item 2'),
},
taskItem(
{
checked: false,
...sourceAttrs('0:23', '1. [ ] task list item 1'),
},
paragraph(sourceAttrs('7:23', 'task list item 1'), 'task list item 1'),
),
taskItem(
{
checked: false,
...sourceAttrs('24:47', '2. [ ] task list item 2'),
},
paragraph(sourceAttrs('31:47', 'task list item 2'), 'task list item 2'),
),
),
),
},
{
markdown: `
| a | b |
|---|---|
| c | d |
`,
expectedDoc: doc(
table(
sourceAttrs('0:29', '| a | b |\n|---|---|\n| c | d |'),
tableRow(
sourceAttrs('0:9', '| a | b |'),
tableHeader(sourceAttrs('0:5', '| a |'), paragraph(sourceAttrs('2:3', 'a'), 'a')),
tableHeader(sourceAttrs('5:9', ' b |'), paragraph(sourceAttrs('6:7', 'b'), 'b')),
),
tableRow(
sourceAttrs('20:29', '| c | d |'),
tableCell(sourceAttrs('20:25', '| c |'), paragraph(sourceAttrs('22:23', 'c'), 'c')),
tableCell(sourceAttrs('25:29', ' d |'), paragraph(sourceAttrs('26:27', 'd'), 'd')),
),
),
),
},
{
markdown: `
<table>
<tr>
<th colspan="2" rowspan="5">Header</th>
</tr>
<tr>
<td colspan="2" rowspan="5">Body</td>
</tr>
</table>
`,
expectedDoc: doc(
table(
sourceAttrs(
'0:132',
'<table>\n <tr>\n <th colspan="2" rowspan="5">Header</th>\n </tr>\n <tr>\n <td colspan="2" rowspan="5">Body</td>\n </tr>\n</table>',
),
tableRow(
sourceAttrs('10:66', '<tr>\n <th colspan="2" rowspan="5">Header</th>\n </tr>'),
tableHeader(
{
...sourceAttrs('19:58', '<th colspan="2" rowspan="5">Header</th>'),
colspan: 2,
rowspan: 5,
},
paragraph(sourceAttrs('47:53', 'Header'), 'Header'),
),
),
tableRow(
sourceAttrs('69:123', '<tr>\n <td colspan="2" rowspan="5">Body</td>\n </tr>'),
tableCell(
{
...sourceAttrs('78:115', '<td colspan="2" rowspan="5">Body</td>'),
colspan: 2,
rowspan: 5,
},
paragraph(sourceAttrs('106:110', 'Body'), 'Body'),
),
),
),
),
},
{
markdown: `
This is a footnote [^footnote]
Paragraph
[^footnote]: Footnote definition
Paragraph
`,
expectedDoc: doc(
paragraph(
sourceAttrs('0:30', 'This is a footnote [^footnote]'),
'This is a footnote ',
footnoteReference({
...sourceAttrs('19:30', '[^footnote]'),
identifier: 'footnote',
label: 'footnote',
}),
),
paragraph(sourceAttrs('32:41', 'Paragraph'), 'Paragraph'),
footnoteDefinition(
{
...sourceAttrs('43:75', '[^footnote]: Footnote definition'),
identifier: 'footnote',
label: 'footnote',
},
paragraph(sourceAttrs('56:75', 'Footnote definition'), 'Footnote definition'),
),
paragraph(sourceAttrs('77:86', 'Paragraph'), 'Paragraph'),
),
},
];
const runOnly = examples.find((example) => example.only === true);
const runExamples = runOnly ? [runOnly] : examples;
it.each(runExamples)('processes %s correctly', async ({ markdown, expectedDoc }) => {
2022-07-16 23:28:13 +05:30
const trimmed = markdown.trim();
const document = await deserialize(trimmed);
2022-07-23 23:45:48 +05:30
expect(expectedDoc).not.toBeFalsy();
expect(document.toJSON()).toEqual(expectedDoc.toJSON());
2022-07-16 23:28:13 +05:30
expect(serialize(document)).toEqual(trimmed);
});
});