1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
import { createEditor } from './../EditorFactory';
import { createMarkdownSerializer } from './../extensions/Markdown'
import spec from "./fixtures/spec"
import markdownit from './../markdownit'
import { typesAvailable } from './../markdownit/callouts'
const markdownThroughEditor = (markdown) => {
const tiptap = createEditor({
content: markdownit.render(markdown),
enableRichEditing: true
})
const serializer = createMarkdownSerializer(tiptap.schema)
return serializer.serialize(tiptap.state.doc)
}
const markdownThroughEditorHtml = (html) => {
const tiptap = createEditor({
content: html,
enableRichEditing: true
})
const serializer = createMarkdownSerializer(tiptap.schema)
return serializer.serialize(tiptap.state.doc)
}
describe('Commonmark', () => {
const skippedMarkdownTests = [
// contain HTML
21, 31, 201, 344, 474, 475, 476, 490, 493, 523, 535, 642, 643,
// contain comments
309, 308,
];
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')
}
spec.forEach((entry) => {
// We do not support HTML
if (entry.section === 'HTML blocks' || entry.section === 'Raw HTML') return;
if (skippedMarkdownTests.indexOf(entry.example) !== -1) {
return
}
test('commonmark parsing ' + entry.example, () => {
const expected = entry.markdown.includes('__')
? entry.html.replace(/<strong>/g, '<u>').replace(/<\/strong>/g, '</u>')
: entry.html
const rendered = markdownit.render(entry.markdown)
// Ignore special markup for untouched markdown
expect(normalize(rendered)).toBe(expected)
})
})
})
describe('Markdown though editor', () => {
test('headlines', () => {
expect(markdownThroughEditor('# Test')).toBe('# Test')
expect(markdownThroughEditor('## Test')).toBe('## Test')
expect(markdownThroughEditor('### Test')).toBe('### Test')
expect(markdownThroughEditor('#### Test')).toBe('#### Test')
expect(markdownThroughEditor('##### Test')).toBe('##### Test')
})
test('hard breaks', () => {
expect(markdownThroughEditor('hard \nbreak')).toBe('hard \nbreak')
expect(markdownThroughEditor('hard\\\nbreak')).toBe('hard \nbreak')
expect(markdownThroughEditor('soft\nbreak')).toBe('soft\nbreak')
})
test('inline format', () => {
expect(markdownThroughEditor('**Test**')).toBe('**Test**')
expect(markdownThroughEditor('__Test__')).toBe('__Test__')
expect(markdownThroughEditor('_Test_')).toBe('*Test*')
expect(markdownThroughEditor('~~Test~~')).toBe('~~Test~~')
expect(markdownThroughEditor('Have an `inline code` element')).toBe('Have an `inline code` element')
})
test('ul', () => {
expect(markdownThroughEditor('- foo\n- bar')).toBe('* foo\n* bar')
expect(markdownThroughEditor('- foo\n\n- bar')).toBe('* foo\n* bar')
expect(markdownThroughEditor('- foo\n\n\n- bar')).toBe('* foo\n* bar')
})
test('ol', () => {
expect(markdownThroughEditor('1. foo\n2. bar')).toBe('1. foo\n2. bar')
})
test('paragraph', () => {
// Test whitespace characters are untouched
expect(markdownThroughEditor('foo\nbar\n\nfoobar\nfoo\tbar')).toBe('foo\nbar\n\nfoobar\nfoo\tbar')
})
test('links', () => {
expect(markdownThroughEditor('[test](foo)')).toBe('[test](foo)')
expect(markdownThroughEditor('[test](foo "bar")')).toBe('[test](foo "bar")')
// Issue #2703
expect(markdownThroughEditor('[bar\\\\]: /uri\n\n[bar\\\\]')).toBe('[bar\\\\](/uri)')
})
test('images', () => {
expect(markdownThroughEditor('')).toBe('')
})
test('special characters', () => {
expect(markdownThroughEditor('"\';&.-#><')).toBe('"\';&.-#><')
})
test('code block', () => {
expect(markdownThroughEditor('```\n<?php echo "Hello World";\n```')).toBe('```\n<?php echo "Hello World";\n```')
})
test('markdown untouched', () => {
// Issue #2703
expect(markdownThroughEditor('[bar\\\\]: /uri\n\n[bar\\\\]')).toBe('[bar\\\\](/uri)')
expect(markdownThroughEditor('## Test \\')).toBe('## Test \\')
expect(markdownThroughEditor('- [ [asd](sdf)')).toBe('* [ [asd](sdf)')
})
test('checkboxes', () => {
// Invalid ones but should be syntactical unchanged
expect(markdownThroughEditor('- [F] asd')).toBe('* [F] asd')
expect(markdownThroughEditor('- [ [asd](sdf)')).toBe('* [ [asd](sdf)')
// Valid, whitespace is allowed inside the checkbox
expect(markdownThroughEditor('- [\t] asd')).toBe('* [ ] asd')
expect(markdownThroughEditor('- [ ] asd')).toBe('* [ ] asd')
// Valid ones
expect(markdownThroughEditor('- [ ] [asd](sdf)')).toBe('* [ ] [asd](sdf)')
expect(markdownThroughEditor('- [x] [asd](sdf)')).toBe('* [x] [asd](sdf)')
expect(markdownThroughEditor('- [ ] foo\n- [x] bar')).toBe('* [ ] foo\n* [x] bar')
expect(markdownThroughEditor('- [x] foo\n' +
' - [ ] bar\n' +
' - [x] baz\n' +
'- [ ] bim')).toBe('* [x] foo\n' +
' * [ ] bar\n' +
' * [x] baz\n' +
'* [ ] bim')
expect(markdownThroughEditor('- [X] asd')).toBe('* [x] asd')
expect(markdownThroughEditor('- [X] asd')).toBe('* [x] asd')
expect(markdownThroughEditorHtml('<ul class="contains-task-list"><li><input type="checkbox" checked /><label>foo</label></li></ul>')).toBe('* [x] foo')
expect(markdownThroughEditorHtml('<ul class="contains-task-list"><li><input type="checkbox" /><label>test</label></li></ul>')).toBe('* [ ] test')
expect(markdownThroughEditorHtml('<ul class="contains-task-list"><li><input type="checkbox" checked /><div><h2>Test</h2><p><strong>content</strong></p></div></li></ul>')).toBe('* [x] Test\n\n **content**')
expect(markdownThroughEditorHtml('<ul class="contains-task-list"><li><input type="checkbox" checked /><p>Test</p><h1>Block level headline</h1></li></ul>')).toBe('* [x] Test\n\n # Block level headline')
})
test('horizontal rule', () => {
expect(markdownThroughEditor('foo\n\n---\n\nfoobar')).toBe('foo\n\n---\n\nfoobar')
})
test('escaping', () => {
const test = '(Asdf [asdf asdf](asdf asdf) asdf asdf asdf asdf asdf asdf asdf asdf asdf)\n' +
'\n' +
'* [asdf asdf asdf/asdf](Asdf Asdf)\n' +
'* asdf asdf asdf [a--f asdf asdf](a--f Asdf Asdf)\n' +
'* [Asdf asdf asdf asdf asdf asdf](Asdf asdf)'
expect(markdownThroughEditor(test)).toBe(test)
expect(markdownThroughEditor('This is a [test] for escaping')).toBe('This is a [test] for escaping')
expect(markdownThroughEditor('This is a [test for escaping')).toBe('This is a [test for escaping')
})
test('callouts', () => {
typesAvailable.forEach(type => {
const entry = `::: ${type}\n!${type}!\n\njust do it\n\n:::`
expect(markdownThroughEditor(entry)).toBe(entry)
})
})
test('mentions', () => {
expect(markdownThroughEditor('@[username](mention://user/id)')).toBe(' @[username](mention://user/id) ')
})
})
describe('Markdown serializer from html', () => {
test('paragraph', () => {
expect(markdownThroughEditorHtml('<p>hello</p><p>world</p>')).toBe('hello\n\nworld')
})
test('hard line breaks', () => {
expect(markdownThroughEditorHtml('<p>hard<br />break</p>')).toBe('hard \nbreak')
expect(markdownThroughEditorHtml('<p>hard<br>break</p>')).toBe('hard \nbreak')
expect(markdownThroughEditorHtml('<p>soft\nbreak</p>')).toBe('soft\nbreak')
})
test('links', () => {
expect(markdownThroughEditorHtml('<a href="foo">test</a>')).toBe('[test](foo)')
})
test('images', () => {
expect(markdownThroughEditorHtml('<img src="image" alt="description" />')).toBe('')
expect(markdownThroughEditorHtml('<p><img src="image" alt="description" /></p>')).toBe('')
})
test('checkboxes', () => {
expect(markdownThroughEditorHtml('<ul class="contains-task-list"><li><input type="checkbox" checked /><label>foo</label></li></ul>')).toBe('* [x] foo')
expect(markdownThroughEditorHtml('<ul class="contains-task-list"><li><input type="checkbox" /><label>test</label></li></ul>')).toBe('* [ ] test')
expect(markdownThroughEditorHtml('<ul class="contains-task-list"><li><input type="checkbox" checked /><div><h2>Test</h2><p><strong>content</strong></p></div></li></ul>')).toBe('* [x] Test\n\n **content**')
expect(markdownThroughEditorHtml('<ul class="contains-task-list"><li><input type="checkbox" checked /><p>Test</p><h1>Block level headline</h1></li></ul>')).toBe('* [x] Test\n\n # Block level headline')
})
test('callouts', () => {
typesAvailable.forEach(type => {
expect(markdownThroughEditorHtml(
`<div data-callout="${type}" class="callout callout-${type}"><p>!${type}!</p>just do it<p></p></div>`
)).toBe(`::: ${type}\n!${type}!\n\njust do it\n\n:::`)
expect(markdownThroughEditorHtml(
`<p class="callout ${type}">!${type}!</p>`
)).toBe(`::: ${type}\n!${type}!\n\n:::`)
})
})
test('callouts with handbook classes', () => {
expect(markdownThroughEditorHtml(
`<p class="callout warning">!warning!</p>`
)).toBe(`::: warn\n!warning!\n\n:::`)
})
test('table cell escaping', () => {
// while '|' has no special meaning in commonmark is has to be escaped for GFM tables
expect(markdownThroughEditorHtml('<table><tr><th>greetings</th></tr><tr><td>hello | hallo</td></tr></table>')).toBe('| greetings |\n|-----------|\n| hello \\| hallo |\n')
})
test('front matter', () => {
expect(markdownThroughEditorHtml('<pre id="frontmatter"><code>some: value</code></pre><h1>Heading</h1>')).toBe('---\nsome: value\n---\n\n# Heading')
// Test --- within front matter is allowed
expect(markdownThroughEditorHtml('<pre id="frontmatter"><code>---</code></pre><h1>Heading</h1>')).toBe('----\n---\n----\n\n# Heading')
})
test('mentions', () => {
expect(markdownThroughEditorHtml('<span class="mention" data-label="username" data-type="user" data-id="id">username</span>')).toBe(' @[username](mention://user/id) ')
})
})
describe('Trailing nodes', () => {
test('No extra transaction is added after loading', () => {
const source = "# My heading\n\n* test\n* test2"
const tiptap = createEditor({
content: markdownit.render(source),
enableRichEditing: true,
})
const jsonBefore = tiptap.getJSON()
// Focus triggers a transaction which is adding the trailing node
// this pushes a step through the collaboration plugin
// Resulting markdown will not contain the trailing paragraph so everytime the tiptap instance is created from the html, this transaction gets dispatched
tiptap.commands.focus()
const jsonAfter = tiptap.getJSON()
expect(jsonAfter).toStrictEqual(jsonBefore)
const serializer = createMarkdownSerializer(tiptap.schema)
const md = serializer.serialize(tiptap.state.doc)
expect(md).toBe(source)
})
})
|
