summaryrefslogtreecommitdiff
path: root/tests/writers/markdown-writer.tests.js
blob: 250bb0cd25b5e17285a4aaed27b76e48f3a050f6 (plain)
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
var assert = require("assert");
var test = require("../testing").test;

var mdWriter = require("../../lib/writers/markdown-writer");

describe('markdown-writer', function() {
    test('special markdown characters are escaped', function() {
        var writer = mdWriter.writer();
        writer.text("\\*");
        return assert.equal(writer.asString(), "\\\\\\*");
    });

    test('can generate a paragraph', function() {
        var writer = mdWriter.writer();
        writer.open("p");
        writer.text("Hello");
        writer.close("p");
        return assert.equal(writer.asString(), "Hello\n\n");
    });

    test('can generate a level 1 heading', function() {
        var writer = mdWriter.writer();
        writer.open("h1");
        writer.text("Hello");
        writer.close("h1");
        return assert.equal(writer.asString(), "# Hello\n\n");
    });

    test('can generate a level 6 heading', function() {
        var writer = mdWriter.writer();
        writer.open("h6");
        writer.text("Hello");
        writer.close("h6");
        return assert.equal(writer.asString(), "###### Hello\n\n");
    });

    test('can generate a new line', function() {
        var writer = mdWriter.writer();
        writer.text("Hello World");
        writer.selfClosing("br");
        return assert.equal(writer.asString(), "Hello World  \n");
    });

    test('can generate strong text', function() {
        var writer = mdWriter.writer();
        writer.text("Hello ");
        writer.open("strong");
        writer.text("World");
        writer.close("strong");
        return assert.equal(writer.asString(), "Hello **World**");
    });
    
    test('can generate emphasis text', function() {
        var writer = mdWriter.writer();
        writer.text("Hello ");
        writer.open("em");
        writer.text("World");
        writer.close("em");
        return assert.equal(writer.asString(), "Hello *World*");
    });

    test('can generate hyperlinks', function() {
        var writer = mdWriter.writer();
        writer.open("a", { "href": "http://example.com" });
        writer.text("Hello");
        writer.close("a");
        return assert.equal(writer.asString(), "[Hello](http://example.com)");
    });

    test('can generate hyperlinks with missing href attribute', function() {
        var writer = mdWriter.writer();
        writer.open("a", {});
        writer.text("Hello");
        writer.close("a");
        return assert.equal(writer.asString(), "[Hello]()");
    });

    test('can generate hyperlinks with empty attributes', function() {
        var writer = mdWriter.writer();
        writer.open("a");
        writer.text("Hello");
        writer.close("a");
        return assert.equal(writer.asString(), "[Hello]()");
    });
    
    test('elements with IDs have anchor tags with IDs appended to start of markdown element', function() {
        var writer = mdWriter.writer();
        writer.open("h1", {id: "start"});
        writer.text("Hello");
        writer.close("p");
        return assert.equal(writer.asString(), '# <a id="start"></a>Hello\n\n');
    });

    test('links have anchors before opening square bracket', function() {
        var writer = mdWriter.writer();
        writer.open("a", {href: "http://example.com", id: "start"});
        writer.text("Hello");
        writer.close("a");
        return assert.equal(writer.asString(), '<a id="start"></a>[Hello](http://example.com)');
    });

    test('can generate images', function() {
        var writer = mdWriter.writer();
        writer.selfClosing("img", { "src": "http://example.com/image.jpg", "alt": "Alt Text" });
        return assert.equal(writer.asString(), "![Alt Text](http://example.com/image.jpg)");
    });

    test('can generate images with missing alt attribute', function() {
        var writer = mdWriter.writer();
        writer.selfClosing("img", { "src": "http://example.com/image.jpg" });
        return assert.equal(writer.asString(), "![](http://example.com/image.jpg)");
    });

    test('can generate images with misssing src attribute', function() {
        var writer = mdWriter.writer();
        writer.selfClosing("img", { "alt": "Alt Text" });
        return assert.equal(writer.asString(), "![Alt Text]()");
    });

    test("doesn't display empty images", function() {
        var writer = mdWriter.writer();
        writer.selfClosing("img");
        return assert.equal(writer.asString(), "");
    });

    test('can generate an ordered list', function() {
        var writer = mdWriter.writer();
        writer.open("ol");
        writer.open("li");
        writer.text("Hello");
        writer.close("li");
        writer.open("li");
        writer.text("World");
        writer.close("li");
        writer.close("ol");
        return assert.equal(writer.asString(), "1. Hello\n2. World\n\n");
    });

    test('can generate an unordered list', function() {
        var writer = mdWriter.writer();
        writer.open("ul");
        writer.open("li");
        writer.text("Hello");
        writer.close("li");
        writer.open("li");
        writer.text("World");
        writer.close("li");
        writer.close("ul");
        return assert.equal(writer.asString(), "- Hello\n- World\n\n");
    });

    test('can generate a nested ordered list with correct numbering', function() {
        var writer = mdWriter.writer();
        writer.open("ol");
        writer.open("li");
        writer.text("Outer One");
        writer.close("li");
        writer.open("li");
        writer.text("Outer Two");

        writer.open("ol");
        writer.open("li");
        writer.text("Nested One");
        writer.close("li");
        writer.open("li");
        writer.text("Nested Two");
        writer.close("li");
        writer.open("li");
        writer.text("Nested Three");
        writer.close("li");
        writer.close("ol");

        writer.close("li");
        writer.open("li");
        writer.text("Outer Three");
        writer.close("li");
        writer.close("ol");
        return assert.equal(writer.asString(), "1. Outer One\n2. Outer Two\n\t1. Nested One\n\t2. Nested Two\n\t3. Nested Three\n3. Outer Three\n\n");
    });

    test('can generate a multi-level nested ordered list with correct numbering', function() {
        var writer = mdWriter.writer();
        writer.open("ol");
        writer.open("li");
        writer.text("Outer One");
        writer.close("li");
        writer.open("li");
        writer.text("Outer Two");

        writer.open("ol");
        writer.open("li");
        writer.text("Nested One");
        writer.close("li");
        writer.open("li");
        writer.text("Nested Two");
        writer.close("li");
        writer.open("li");
        writer.text("Nested Three");

        writer.open("ol");
        writer.open("li");
        writer.text("Inner One");
        writer.close("li");
        writer.open("li");
        writer.text("Inner Two");
        writer.close("li");
        writer.open("li");
        writer.text("Inner Three");
        writer.close("li");
        writer.open("li");
        writer.text("Inner Four");
        writer.close("li");
        writer.close("ol");

        writer.close("li");
        writer.open("li");
        writer.text("Nested Four");
        writer.close("li");
        writer.close("ol");

        writer.close("li");
        writer.open("li");
        writer.text("Outer Three");
        writer.close("li");
        writer.close("ol");
        return assert.equal(writer.asString(), "1. Outer One\n2. Outer Two\n\t1. Nested One\n\t2. Nested Two\n\t3. Nested Three\n\t\t1. Inner One\n\t\t2. Inner Two\n\t\t3. Inner Three\n\t\t4. Inner Four\n\t4. Nested Four\n3. Outer Three\n\n");
    });

    test('can generate sequential ordered lists with correct numbering', function() {
        var writer = mdWriter.writer();
        writer.open("ol");
        writer.open("li");
        writer.text("First One");
        writer.close("li");
        writer.open("li");
        writer.text("First Two");
        writer.close("li");
        writer.close("ol");

        writer.open("ol");
        writer.open("li");
        writer.text("Second One");
        writer.close("li");
        writer.open("li");
        writer.text("Second Two");
        writer.close("li");
        writer.open("li");
        writer.text("Second Three");
        writer.close("li");
        writer.close("ol");

        return assert.equal(writer.asString(), "1. First One\n2. First Two\n\n1. Second One\n2. Second Two\n3. Second Three\n\n");
    });

    test('can generate a nested unordered list', function() {
        var writer = mdWriter.writer();
        writer.open("ul");
        writer.open("li");
        writer.text("Outer One");
        writer.close("li");
        writer.open("li");
        writer.text("Outer Two");

        writer.open("ul");
        writer.open("li");
        writer.text("Nested One");
        writer.close("li");
        writer.open("li");
        writer.text("Nested Two");
        writer.close("li");
        writer.open("li");
        writer.text("Nested Three");
        writer.close("li");
        writer.close("ul");

        writer.close("li");
        writer.open("li");
        writer.text("Outer Three");
        writer.close("li");
        writer.close("ul");
        return assert.equal(writer.asString(), "- Outer One\n- Outer Two\n\t- Nested One\n\t- Nested Two\n\t- Nested Three\n- Outer Three\n\n");
    });

    test('can nest inline elements', function() {
        var writer = mdWriter.writer();
        writer.open("p");
        writer.text("Lorem ");
        writer.open("strong");
        writer.text("ipsum ");
        writer.open("em");
        writer.text("dolor");
        writer.close("em");
        writer.text(" sit");
        writer.close("strong");
        writer.text(" amet");
        writer.close("p");
        return assert.equal(writer.asString(), "Lorem **ipsum *dolor* sit** amet\n\n");
    });

    test('can emphasise list text', function() {
        var writer = mdWriter.writer();
        writer.open("ol");
        writer.open("li");
        writer.text("Hello ");
        writer.open("strong");
        writer.text("Strong");
        writer.close("strong");
        writer.text(" World");
        writer.close("li");
        writer.open("li");
        writer.text("Hello ");
        writer.open("em");
        writer.text("Emphasis");
        writer.close("em");
        writer.text(" World");
        writer.close("li");
        writer.close("ol");
        return assert.equal(writer.asString(), "1. Hello **Strong** World\n2. Hello *Emphasis* World\n\n");
    });

    test('blank paragraphs are removed', function() {
        var writer = mdWriter.writer();
        writer.open("p");
        writer.text("Hello");
        writer.close("p");
        writer.open("p");
        writer.text("");
        writer.close("p");
        writer.open("p");
        writer.text("");
        writer.close("p");
        writer.open("p");
        writer.text("World");
        writer.close("p");
        return assert.equal(writer.asString(), "Hello\n\nWorld\n\n");
    });

    test('generates correct spacing between paragraphs and lists', function() {
        var writer = mdWriter.writer();
        writer.open("p");
        writer.text("Hello World");
        writer.close("p");
        writer.open("ul");
        writer.open("li");
        writer.text("First Item");
        writer.close("li");
        writer.open("li");
        writer.text("Second Item");
        writer.close("li");
        writer.close("ul");
        writer.open("p");
        writer.text("Hello World");
        writer.close("p");
        return assert.equal(writer.asString(), "Hello World\n\n- First Item\n- Second Item\n\nHello World\n\n");
    });
});