forked from eslint/eslint-plugin-markdown
/
processor.js
637 lines (536 loc) · 19.8 KB
/
processor.js
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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
/**
* @fileoverview Tests for the Markdown processor.
* @author Brandon Mills
*/
"use strict";
const assert = require("chai").assert,
processor = require("../../lib/processor");
describe("processor", () => {
describe("preprocess", () => {
it("should not crash", () => {
processor.preprocess("Hello, world!");
});
it("should not crash on an empty string", () => {
processor.preprocess("");
});
it("should return an array", () => {
assert.isArray(processor.preprocess("Hello, world!"));
});
it("should ignore normal text", () => {
const blocks = processor.preprocess("Hello, world!");
assert.strictEqual(blocks.length, 0);
});
it("should ignore inline code", () => {
const blocks = processor.preprocess("Hello, `{{name}}!");
assert.strictEqual(blocks.length, 0);
});
it("should ignore space-indented code blocks", () => {
const code = [
"Hello, world!",
" ",
" var answer = 6 * 7;",
" ",
"Goodbye"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 0);
});
it("should ignore 4-space-indented code fences", () => {
const code = [
"Hello, world!",
" ```js",
" var answer = 6 * 7;",
" ```",
"Goodbye"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 0);
});
it("should ignore 4-space-indented fence ends", () => {
const code = [
"Hello, world!",
"```js",
"var answer = 6 * 7;",
" ```",
"Goodbye"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0], "var answer = 6 * 7;\n ```\nGoodbye\n");
});
it("should ignore tab-indented code blocks", () => {
const code = [
"Hello, world!",
"\t",
"\tvar answer = 6 * 7;",
"\t",
"Goodbye"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 0);
});
it("should terminate blocks at EOF", () => {
const code = [
"Hello, world!",
"```js",
"var answer = 6 * 7;"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0], "var answer = 6 * 7;\n");
});
it("should allow backticks or tildes", () => {
const code = [
"```js",
"backticks",
"```",
"~~~javascript",
"tildes",
"~~~"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 2);
assert.strictEqual(blocks[0], "backticks\n");
assert.strictEqual(blocks[1], "tildes\n");
});
it("should allow more than three fence characters", () => {
const code = [
"````js",
"four",
"````"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0], "four\n");
});
it("should require end fences at least as long as the starting fence", () => {
const code = [
"````js",
"four",
"```",
"````",
"`````js",
"five",
"`````",
"``````js",
"six",
"```````"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 3);
assert.strictEqual(blocks[0], "four\n```\n");
assert.strictEqual(blocks[1], "five\n");
assert.strictEqual(blocks[2], "six\n");
});
it("should not allow other content on ending fence line", () => {
const code = [
"```js",
"test();",
"``` end",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0], "test();\n``` end\n");
});
it("should allow empty blocks", () => {
const code = [
"```js",
"",
"````"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0], "\n");
});
it("should allow whitespace-only blocks", () => {
const code = [
" ```js",
"",
" ",
" ",
" ",
" ",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0], "\n\n\n \n \n");
});
it("should ignore code fences with unspecified info string", () => {
const code = [
"```",
"var answer = 6 * 7;",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 0);
});
it("should find code fences with js info string", () => {
const code = [
"```js",
"var answer = 6 * 7;",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
});
it("should find code fences with javascript info string", () => {
const code = [
"```javascript",
"var answer = 6 * 7;",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
});
it("should find code fences with node info string", () => {
const code = [
"```node",
"var answer = 6 * 7;",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
});
it("should find code fences with jsx info string", () => {
const code = [
"```jsx",
"var answer = 6 * 7;",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
});
it("should find code fences ignoring info string case", () => {
const code = [
"```JavaScript",
"var answer = 6 * 7;",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
});
it("should ignore anything after the first word of the info string", () => {
const code = [
"```js more words are ignored",
"var answer = 6 * 7;",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
});
it("should find code fences not surrounded by blank lines", () => {
const code = [
"<!-- eslint-disable -->",
"```js",
"var answer = 6 * 7;",
"```",
"Paragraph text",
"```js",
"var answer = 6 * 7;",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 2);
});
it("should return the source code in the block", () => {
const code = [
"```js",
"var answer = 6 * 7;",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks[0], "var answer = 6 * 7;\n");
});
it("should allow multi-line source code", () => {
const code = [
"```js",
"var answer = 6 * 7;",
"console.log(answer);",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks[0], "var answer = 6 * 7;\nconsole.log(answer);\n");
});
it("should preserve original line endings", () => {
const code = [
"```js",
"var answer = 6 * 7;",
"console.log(answer);",
"```"
].join("\r\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks[0], "var answer = 6 * 7;\nconsole.log(answer);\n");
});
it("should unindent space-indented code fences", () => {
const code = [
" ```js",
" var answer = 6 * 7;",
" console.log(answer);",
" // Fin.",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks[0], "var answer = 6 * 7;\n console.log(answer);\n// Fin.\n");
});
it("should find multiple code fences", () => {
const code = [
"Hello, world!",
"",
"```js",
"var answer = 6 * 7;",
"```",
"",
"```javascript",
"console.log(answer);",
"```",
"",
"Goodbye"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 2);
assert.strictEqual(blocks[0], "var answer = 6 * 7;\n");
assert.strictEqual(blocks[1], "console.log(answer);\n");
});
it("should insert leading configuration comments", () => {
const code = [
"<!-- eslint-env browser -->",
"<!--",
" eslint quotes: [",
" \"error\",",
" \"single\"",
" ]",
"-->",
"",
"```js",
"alert('Hello, world!');",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0], [
"/* eslint-env browser */",
"/*",
" eslint quotes: [",
" \"error\",",
" \"single\"",
" ]",
"*/",
"alert('Hello, world!');",
""
].join("\n"));
});
it("should insert global comments", () => {
const code = [
"<!-- global foo -->",
"<!-- global bar:false, baz:true -->",
"",
"```js",
"alert(foo, bar, baz);",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0], [
"/* global foo */",
"/* global bar:false, baz:true */",
"alert(foo, bar, baz);",
""
].join("\n"));
});
it("should ignore non-eslint comments", () => {
const code = [
"<!-- eslint-env browser -->",
"<!-- not an eslint comment -->",
"",
"```js",
"alert('Hello, world!');",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0], [
"alert('Hello, world!');",
""
].join("\n"));
});
it("should ignore non-comment html", () => {
const code = [
"<!-- eslint-env browser -->",
"<p>For example:</p>",
"",
"```js",
"alert('Hello, world!');",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0], [
"alert('Hello, world!');",
""
].join("\n"));
});
describe("eslint-skip", () => {
it("should skip the next block", () => {
const code = [
"<!-- eslint-skip -->",
"",
"```js",
"alert('Hello, world!');",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 0);
});
it("should skip only one block", () => {
const code = [
"<!-- eslint-skip -->",
"",
"```js",
"alert('Hello, world!');",
"```",
"",
"```js",
"var answer = 6 * 7;",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0], "var answer = 6 * 7;\n");
});
it("should still work surrounded by other comments", () => {
const code = [
"<!-- eslint-disable no-console -->",
"<!-- eslint-skip -->",
"<!-- eslint-disable quotes -->",
"",
"```js",
"alert('Hello, world!');",
"```",
"",
"```js",
"var answer = 6 * 7;",
"```"
].join("\n");
const blocks = processor.preprocess(code);
assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0], "var answer = 6 * 7;\n");
});
});
});
describe("postprocess", () => {
const code = [
"Hello, world!",
"",
"```js",
"var answer = 6 * 7;",
"if (answer === 42) {",
" console.log(answer);",
"}",
"```",
"",
"Let's make a list.",
"",
"1. First item",
"",
" ```JavaScript",
" var arr = [",
" 1,",
" 2",
" ];",
" ```",
"",
"1. Second item",
"",
" ```JS",
" function boolean(arg) {",
" \treturn",
" \t!!arg;",
"};",
" ```"
].join("\n");
const messages = [
[
{ line: 1, endLine: 1, column: 1, message: "Use the global form of \"use strict\".", ruleId: "strict" },
{ line: 3, endLine: 3, column: 5, message: "Unexpected console statement.", ruleId: "no-console" }
], [
{ line: 3, endLine: 3, column: 6, message: "Missing trailing comma.", ruleId: "comma-dangle", fix: { range: [24, 24], text: "," } }
], [
{ line: 3, endLine: 6, column: 2, message: "Unreachable code after return.", ruleId: "no-unreachable" },
{ line: 4, endLine: 4, column: 2, message: "Unnecessary semicolon.", ruleId: "no-extra-semi", fix: { range: [38, 39], text: "" } }
]
];
beforeEach(() => {
processor.preprocess(code);
});
it("should allow for no messages", () => {
const result = processor.postprocess([[], [], []]);
assert.strictEqual(result.length, 0);
});
it("should flatten messages", () => {
const result = processor.postprocess(messages);
assert.strictEqual(result.length, 5);
assert.strictEqual(result[0].message, "Use the global form of \"use strict\".");
assert.strictEqual(result[1].message, "Unexpected console statement.");
assert.strictEqual(result[2].message, "Missing trailing comma.");
assert.strictEqual(result[3].message, "Unreachable code after return.");
assert.strictEqual(result[4].message, "Unnecessary semicolon.");
});
it("should translate line numbers", () => {
const result = processor.postprocess(messages);
assert.strictEqual(result[0].line, 4);
assert.strictEqual(result[1].line, 6);
assert.strictEqual(result[2].line, 17);
assert.strictEqual(result[3].line, 26);
assert.strictEqual(result[4].line, 27);
});
it("should translate endLine numbers", () => {
const result = processor.postprocess(messages);
assert.strictEqual(result[0].endLine, 4);
assert.strictEqual(result[1].endLine, 6);
assert.strictEqual(result[2].endLine, 17);
assert.strictEqual(result[3].endLine, 29);
assert.strictEqual(result[4].endLine, 27);
});
it("should translate column numbers", () => {
const result = processor.postprocess(messages);
assert.strictEqual(result[0].column, 1);
assert.strictEqual(result[1].column, 5);
});
it("should translate indented column numbers", () => {
const result = processor.postprocess(messages);
assert.strictEqual(result[2].column, 9);
assert.strictEqual(result[3].column, 2);
assert.strictEqual(result[4].column, 2);
});
it("should adjust fix range properties", () => {
const result = processor.postprocess(messages);
assert(result[2].fix.range, [185, 185]);
assert(result[4].fix.range, [264, 265]);
});
describe("should exclude messages from unsatisfiable rules", () => {
it("eol-last", () => {
const result = processor.postprocess([
[
{ line: 4, column: 3, message: "Newline required at end of file but not found.", ruleId: "eol-last" }
]
]);
assert.strictEqual(result.length, 0);
});
it("unicode-bom", () => {
const result = processor.postprocess([
[
{ line: 1, column: 1, message: "Expected Unicode BOM (Byte Order Mark).", ruleId: "unicode-bom" }
]
]);
assert.strictEqual(result.length, 0);
});
});
});
describe("supportsAutofix", () => {
it("should equal true", () => {
assert.strictEqual(processor.supportsAutofix, true);
});
});
});