Skip to content

WIP: Test also CommonMark serialization #3331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
susnux wants to merge 2 commits into from
Closed

WIP: Test also CommonMark serialization #3331

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e30ee5
Test also markdown serialization
susnux Oct 28, 2022
c804604
Remove hacky testing of commonmark parsing testing
susnux Nov 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 16 additions & 28 deletions src/tests/markdown.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,49 +15,37 @@ import createEditor from "../EditorFactory";
* Please add test belonging to some Node or Mark to the corresponding file in './nodes/` or `./marks/`
*/

// Goal: Input (commonmark) markdown should result in same output markdown
describe('Commonmark', () => {
const skippedMarkdownTests = [
// we interpret this as front matter
96, 98,
// contain HTML
21, 31, 201, 344, 474, 475, 476, 490, 493, 523, 535, 642, 643,
21, 31, 344, 474, 475, 476, 642, 643,
// contain comments
309, 308,
// < > are escaped, because HTML is disabled for markdown-it
//201, 490, 493, 523, 535
];

const normalize = (str) => {
// https://github.com/markdown-it/markdown-it/blob/df4607f1d4d4be7fdc32e71c04109aea8cc373fa/test/commonmark.js#L10
return str.replace(/<blockquote><\/blockquote>/g, '<blockquote>\n</blockquote>')
.replace(/<span class="keep-md">([^<]+)<\/span>/g, '$1')
.replace(/<br data-syntax=".{1,2}" \/>/g, '<br />\n')
.replace(/<ul data-bullet="."/g, '<ul')
}

// special treatment because we use markdown-it-image-figures
const figureImageMarkdownTests = [
516, 519, 530, 571, 572, 573, 574, 575, 576, 577, 579, 580, 581, 582, 583, 584, 585, 587, 588, 590
]

spec.forEach((entry) => {
// We do not support HTML
if (entry.section === 'HTML blocks' || entry.section === 'Raw HTML') return;

if (skippedMarkdownTests.indexOf(entry.example) !== -1) {
if (entry.section === 'HTML blocks' ||
entry.section === 'Raw HTML' ||
skippedMarkdownTests.indexOf(entry.example) !== -1) {
return
}

test('commonmark parsing ' + entry.example, () => {
let expected = entry.markdown.includes('__')
? entry.html.replace(/<strong>/g, '<u>').replace(/<\/strong>/g, '</u>')
: entry.html
if (figureImageMarkdownTests.indexOf(entry.example) !== -1) {
expected = expected.replace(/<p>/g, '<figure>').replace(/<\/p>/g, '</figure>')
}

const rendered = markdownit.render(entry.markdown)
test('serializing ' + entry.example, () => {
const expected = markdownit.render(entry.markdown)
const serialized = markdownThroughEditorHtml(expected)

// Ignore special markup for untouched markdown
expect(normalize(rendered)).toBe(expected)
try {
expect(markdownit.render(serialized)).toBe(expected)
} catch(e) {
// This is just for debugging, so jest shows also the difference within the two markdown source codes
expect(markdownit.render(serialized) + '\n\n' + serialized).toBe(expected + '\n\n' + entry.markdown)
}
})
})
})
Expand Down