-
Notifications
You must be signed in to change notification settings - Fork 82
/
test.js
860 lines (770 loc) · 32.5 KB
/
test.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
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
'use strict';
const fs = require('node:fs');
const path = require('node:path');
const os = require('node:os');
const process = require('node:process');
const test = require('ava');
const execa = (...arguments_) => import('execa').then(module => module.execa(...arguments_));
const errorPattern = /(\.md|\.markdown|\.mdf|stdin):\d+(:\d+)? MD\d{3}/gm;
process.chdir('./test');
test('--version option', async t => {
const result = await execa('../markdownlint.js', ['--version'], {stripFinalNewline: false});
t.regex(result.stdout, /^\d+\.\d+\.\d+\n$/);
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('--help option', async t => {
const result = await execa('../markdownlint.js', ['--help'], {stripFinalNewline: false});
t.true(result.stdout.includes('markdownlint'));
t.true(result.stdout.includes('--version'));
t.true(result.stdout.includes('--help'));
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('no files shows help', async t => {
const result = await execa('../markdownlint.js', [], {stripFinalNewline: false});
t.true(result.stdout.includes('--help'));
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('files and --stdin shows help', async t => {
const result = await execa('../markdownlint.js', ['--stdin', 'correct.md'], {stripFinalNewline: false});
t.true(result.stdout.includes('--help'));
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('--fix and --stdin shows help', async t => {
const result = await execa('../markdownlint.js', ['--fix', '--stdin', 'correct.md'], {stripFinalNewline: false});
t.true(result.stdout.includes('--help'));
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('linting of correct Markdown file yields no output', async t => {
const result = await execa('../markdownlint.js', ['--config', 'test-config.json', 'correct.md'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('linting of correct Markdown file yields no output with absolute path', async t => {
const result = await execa('../markdownlint.js', ['--config', path.resolve('test-config.json'), 'correct.md'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('linting of correct Markdown file with inline JSONC configuration yields no output', async t => {
const result = await execa('../markdownlint.js', ['inline-jsonc.md'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('linting of correct Markdown file with inline YAML configuration yields no output', async t => {
const result = await execa('../markdownlint.js', ['inline-yaml.md'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('linting of incorrect Markdown file fails', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', 'incorrect.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 7);
t.is(error.exitCode, 1);
}
});
test('linting of incorrect Markdown file fails prints issues as json', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', 'incorrect.md', '--json'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
const issues = JSON.parse(error.stderr);
t.is(issues.length, 7);
const issue = issues[0];
// Property "ruleInformation" changes with library version
t.true(issue.ruleInformation.length > 0);
issue.ruleInformation = null;
const expected = {
fileName: 'incorrect.md',
lineNumber: 1,
ruleNames: ['MD041', 'first-line-heading', 'first-line-h1'],
ruleDescription: 'First line in a file should be a top-level heading',
ruleInformation: null,
errorContext: '## header 2',
errorDetail: null,
errorRange: null,
fixInfo: null
};
t.deepEqual(issues[0], expected);
t.is(error.exitCode, 1);
}
});
test('linting of incorrect Markdown file fails with absolute path', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', path.resolve('incorrect.md')], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 7);
t.is(error.exitCode, 1);
}
});
test('linting of unreadable Markdown file fails', async t => {
const unreadablePath = '../unreadable.test.md';
fs.symlinkSync('nonexistent.dest.md', unreadablePath, 'file');
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', unreadablePath], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.exitCode, 4);
} finally {
fs.unlinkSync(unreadablePath, {force: true});
}
});
test('linting of incorrect Markdown via npm run file fails with eol', async t => {
try {
await execa('npm', ['run', 'invalid'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.regex(error.stderr, /MD\d{3}.*((\nnpm ERR!)|(\n$))/);
}
});
test('glob linting works with passing files', async t => {
const result = await execa('../markdownlint.js', ['--config', 'test-config.json', '**/correct.md'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('glob linting works with failing files', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', '**/*.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 15);
t.is(error.exitCode, 1);
}
});
test('dir linting works with passing .markdown files', async t => {
const result = await execa('../markdownlint.js', ['--config', 'test-config.json', 'subdir-correct'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('dir linting works with failing .markdown files', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', 'subdir-incorrect'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 9);
t.is(error.exitCode, 1);
}
});
test('dir linting works with failing .markdown files and absolute path', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', path.resolve('subdir-incorrect')], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 9);
t.is(error.exitCode, 1);
}
});
test('glob linting with failing files passes when failures ignored by glob', async t => {
const result = await execa('../markdownlint.js', ['--config', 'test-config.json', '**/*.md', '--ignore', '**/incorrect.md'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('glob linting with failing files passes when everything ignored by glob', async t => {
const result = await execa('../markdownlint.js', ['--config', 'test-config.json', '**/*.md', '--ignore', '**/*'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('glob linting with failing files has fewer errors when ignored by dir', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', '**/*.md', '--ignore', 'subdir-incorrect'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 8);
t.is(error.exitCode, 1);
}
});
test('glob linting with failing files has fewer errors when ignored by dir and absolute path', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', '**/*.md', '--ignore', path.resolve('subdir-incorrect')], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 8);
t.is(error.exitCode, 1);
}
});
test('dir linting with failing files has fewer errors when ignored by file', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', 'subdir-incorrect', '--ignore', 'subdir-incorrect/incorrect.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 2);
t.is(error.exitCode, 1);
}
});
test('dir linting with failing files has fewer errors when ignored by file and absolute path', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', path.resolve('subdir-incorrect'), '--ignore', 'subdir-incorrect/incorrect.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 2);
t.is(error.exitCode, 1);
}
});
test('glob linting with failing files passes when ignored by multiple globs', async t => {
const result = await execa('../markdownlint.js', ['--config', 'test-config.json', 'subdir-incorrect', '--ignore', '**/*.md', '--ignore', '**/*.markdown'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('linting results are sorted by file/line/names/description', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', 'incorrect.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
const expected = ['incorrect.md:1 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## header 2"]', 'incorrect.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## header 2"]', 'incorrect.md:2 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "# header"]', 'incorrect.md:5:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ code"]', 'incorrect.md:11:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ code"]', 'incorrect.md:17:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ code"]', 'incorrect.md:23:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ code"]', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
}
});
test('glob linting does not try to lint directories as files', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', '**/*', '--ignore', '**/*.mdf'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.true(error.stderr.match(errorPattern).length > 0);
t.is(error.exitCode, 1);
}
});
test('--stdin with empty input has no output', async t => {
const input = '';
const result = await execa('../markdownlint.js', ['--stdin'], {input, stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('--stdin with valid input has no output', async t => {
const input = ['# Heading', '', 'Text', ''].join('\n');
const result = await execa('../markdownlint.js', ['--stdin'], {input, stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('--stdin with invalid input reports violations', async t => {
const input = ['Heading', '', 'Text ', ''].join('\n');
try {
await execa('../markdownlint.js', ['--stdin'], {input, stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 2);
t.is(error.exitCode, 1);
}
});
test('stdin support does not interfere with file linting', async t => {
const result = await execa('../markdownlint.js', ['--config', 'md043-config.json', 'md043-config.md'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('--output with empty input has empty output', async t => {
const input = '';
const output = '../outputA.txt';
const result = await execa('../markdownlint.js', ['--stdin', '--output', output], {input, stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
t.is(fs.readFileSync(output, 'utf8'), '');
fs.unlinkSync(output);
});
test('--output with valid input has empty output', async t => {
const input = ['# Heading', '', 'Text', ''].join('\n');
const output = '../outputB.txt';
const result = await execa('../markdownlint.js', ['--stdin', '--output', output], {input, stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
t.is(fs.readFileSync(output, 'utf8'), '');
fs.unlinkSync(output);
});
test('--output with invalid input outputs violations', async t => {
const input = ['Heading', '', 'Text ', ''].join('\n');
const output = '../outputC.txt';
try {
await execa('../markdownlint.js', ['--stdin', '--output', output], {input, stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr, '');
t.is(error.exitCode, 1);
t.is(fs.readFileSync(output, 'utf8').match(errorPattern).length, 2);
fs.unlinkSync(output);
}
});
test('--output with invalid input and --json outputs issues as json', async t => {
const input = ['Heading', '', 'Text ', ''].join('\n');
const output = '../outputF.json';
try {
await execa('../markdownlint.js', ['--stdin', '--output', output, '--json'], {input, stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr, '');
t.is(error.exitCode, 1);
t.is(JSON.parse(fs.readFileSync(output)).length, 2);
fs.unlinkSync(output);
}
});
test('--output with invalid path fails', async t => {
const input = '';
const output = 'invalid/outputD.txt';
try {
await execa('../markdownlint.js', ['--stdin', '--output', output], {input, stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.replace(/: ENOENT[^]*$/, ''), 'Cannot write to output file ' + output);
t.is(error.exitCode, 2);
t.throws(() => fs.accessSync(output, 'utf8'));
}
});
test('configuration file can be YAML', async t => {
const result = await execa('../markdownlint.js', ['--config', 'md043-config.yaml', 'md043-config.md'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('configuration file can be JavaScript', async t => {
const result = await execa('../markdownlint.js', ['--config', 'md043-config.js', 'md043-config.md'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('configuration file can be TOML', async t => {
const result = await execa('../markdownlint.js', ['--config', 'md043-config.toml', 'md043-config.md'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('linting using a toml configuration file works', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.toml', '**/*.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 15);
t.is(error.exitCode, 1);
}
});
test('linting using a yaml configuration file works', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.yaml', '**/*.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 15);
t.is(error.exitCode, 1);
}
});
test('error on configuration file not found', async t => {
try {
await execa('../markdownlint.js', ['--config', 'non-existent-file-path.yaml', 'correct.md'], {stripFinalNewline: false});
} catch (error) {
t.is(error.stdout, '');
t.regex(error.stderr, /Cannot read or parse config file 'non-existent-file-path\.yaml': ENOENT: no such file or directory, open '.*non-existent-file-path\.yaml'/);
t.is(error.exitCode, 4);
}
});
test('error on malformed YAML configuration file', async t => {
try {
await execa('../markdownlint.js', ['--config', 'malformed-config.yaml', 'correct.md'], {stripFinalNewline: false});
} catch (error) {
t.is(error.stdout, '');
t.regex(error.stderr, /Cannot read or parse config file 'malformed-config.yaml': Unable to parse 'malformed-config.yaml'; Parser 0:/);
t.is(error.exitCode, 4);
}
});
function getCwdConfigFileTest(extension) {
return async t => {
try {
await execa(path.resolve('..', 'markdownlint.js'), ['.'], {
cwd: path.join(__dirname, 'config-files', extension),
stripFinalNewline: false
});
t.fail();
} catch (error) {
const expected = ["heading-dollar.md:1:10 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '$']", ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
}
};
}
test('.markdownlint.jsonc in cwd is used automatically', getCwdConfigFileTest('jsonc'));
test('.markdownlint.json in cwd is used automatically', getCwdConfigFileTest('json'));
test('.markdownlint.yaml in cwd is used automatically', getCwdConfigFileTest('yaml'));
test('.markdownlint.yml in cwd is used automatically', getCwdConfigFileTest('yml'));
test('.markdownlint.jsonc in cwd is used instead of .markdownlint.json or .markdownlint.yaml or .markdownlint.yml', getCwdConfigFileTest('jsonc-json-yaml-yml'));
test('.markdownlint.json in cwd is used instead of .markdownlint.yaml or .markdownlint.yml', getCwdConfigFileTest('json-yaml-yml'));
test('.markdownlint.yaml in cwd is used instead of .markdownlint.yml', getCwdConfigFileTest('yaml-yml'));
test('.markdownlint.json with JavaScript-style comments is handled', getCwdConfigFileTest('json-c'));
test('Custom rule from single file loaded', async t => {
try {
const input = '# Input\n';
await execa('../markdownlint.js', ['--rules', 'custom-rules/files/test-rule-1.js', '--stdin'], {input, stripFinalNewline: false});
t.fail();
} catch (error) {
const expected = ['stdin:1 test-rule-1 Test rule broken', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
}
});
test('Multiple custom rules from single file loaded', async t => {
try {
const input = '# Input\n';
await execa('../markdownlint.js', ['--rules', 'custom-rules/files/test-rule-3-4.js', '--stdin'], {input, stripFinalNewline: false});
t.fail();
} catch (error) {
const expected = ['stdin:1 test-rule-3 Test rule 3 broken', 'stdin:1 test-rule-4 Test rule 4 broken', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
}
});
test('Custom rules from directory loaded', async t => {
try {
const input = '# Input\n';
await execa('../markdownlint.js', ['--rules', 'custom-rules/files', '--stdin'], {input, stripFinalNewline: false});
t.fail();
} catch (error) {
const expected = ['stdin:1 test-rule-1 Test rule broken', 'stdin:1 test-rule-2 Test rule 2 broken', 'stdin:1 test-rule-3 Test rule 3 broken', 'stdin:1 test-rule-4 Test rule 4 broken', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
}
});
test('Custom rules from glob loaded', async t => {
try {
const input = '# Input\n';
await execa('../markdownlint.js', ['--rules', 'custom-rules/files/**/*.js', '--stdin'], {input, stripFinalNewline: false});
t.fail();
} catch (error) {
const expected = ['stdin:1 test-rule-1 Test rule broken', 'stdin:1 test-rule-2 Test rule 2 broken', 'stdin:1 test-rule-3 Test rule 3 broken', 'stdin:1 test-rule-4 Test rule 4 broken', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
}
});
test('Custom rule from node_modules package loaded', async t => {
try {
const input = '# Input\n';
await execa('../markdownlint.js', ['--rules', 'markdownlint-cli-local-test-rule', '--stdin'], {input, stripFinalNewline: false});
t.fail();
} catch (error) {
const expected = ['stdin:1 markdownlint-cli-local-test-rule Test rule package broken', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
}
});
test('Custom rule from node_modules package loaded relative to cwd', async t => {
try {
const input = '# Input\n';
await execa(path.resolve('..', 'markdownlint.js'), ['--rules', 'markdownlint-cli-local-test-rule', '--stdin'], {
input,
cwd: path.join(__dirname, 'custom-rules', 'relative-to-cwd'),
stripFinalNewline: false
});
t.fail();
} catch (error) {
const expected = ['stdin:1 markdownlint-cli-local-test-rule Test rule package relative to cwd broken', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
}
});
test('Custom rule with scoped package name via --rules', async t => {
try {
await execa(path.resolve('..', 'markdownlint.js'), ['--rules', '@scoped/custom-rule', 'scoped-test.md'], {
cwd: path.join(__dirname, 'custom-rules', 'scoped-package'),
stripFinalNewline: false
});
t.fail();
} catch (error) {
const expected = ['scoped-test.md:1 scoped-rule Scoped rule', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
}
});
test('Custom rule from package loaded', async t => {
try {
const input = '# Input\n';
await execa('../markdownlint.js', ['--rules', './custom-rules/markdownlint-cli-local-test-rule', '--stdin'], {input, stripFinalNewline: false});
t.fail();
} catch (error) {
const expected = ['stdin:1 markdownlint-cli-local-test-rule Test rule package broken', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
}
});
test('Custom rule from several packages loaded', async t => {
try {
const input = '# Input\n';
await execa('../markdownlint.js', ['--rules', './custom-rules/markdownlint-cli-local-test-rule', '--rules', './custom-rules/markdownlint-cli-local-test-rule-other', '--stdin'], {input, stripFinalNewline: false});
t.fail();
} catch (error) {
const expected = ['stdin:1 markdownlint-cli-local-test-rule Test rule package broken', 'stdin:1 markdownlint-cli-local-test-rule-other Test rule package other broken', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
}
});
test('Invalid custom rule name reports error', async t => {
try {
const input = '# Input\n';
await execa('../markdownlint.js', ['--rules', 'markdownlint-cli-local-test-rule', '--rules', 'invalid-package', '--stdin'], {input, stripFinalNewline: false});
t.fail();
} catch (error) {
const expected = ['Cannot load custom rule invalid-package: No such rule', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 3);
}
});
test('fixing errors in a file yields fewer errors', async t => {
const fixFileA = 'incorrect.a.mdf';
try {
fs.copyFileSync('incorrect.md', fixFileA);
await execa('../markdownlint.js', ['--fix', '--config', 'test-config.json', fixFileA], {stripFinalNewline: false});
t.fail();
} catch (error) {
const expected = [fixFileA + ':1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## header 2"]', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
fs.unlinkSync(fixFileA);
}
});
test('fixing errors in a file with absolute path yields fewer errors', async t => {
const fixFileB = 'incorrect.b.mdf';
try {
fs.copyFileSync('incorrect.md', fixFileB);
await execa('../markdownlint.js', ['--fix', '--config', 'test-config.json', path.resolve(fixFileB)], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 1);
t.is(error.exitCode, 1);
fs.unlinkSync(fixFileB);
}
});
test('fixing errors with a glob yields fewer errors', async t => {
const fixFileC = 'incorrect.c.mdf';
const fixSubFileC = 'subdir-incorrect/incorrect.c.mdf';
const fixFileGlob = '**/*.c.mdf';
try {
fs.copyFileSync('incorrect.md', fixFileC);
fs.copyFileSync('subdir-incorrect/incorrect.md', fixSubFileC);
await execa('../markdownlint.js', ['--fix', '--config', 'test-config.json', fixFileGlob], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 2);
t.is(error.exitCode, 1);
fs.unlinkSync(fixFileC);
fs.unlinkSync(fixSubFileC);
}
});
test('.markdownlintignore is applied correctly', async t => {
try {
await execa(path.resolve('..', 'markdownlint.js'), ['.'], {
cwd: path.join(__dirname, 'markdownlintignore'),
stripFinalNewline: false
});
t.fail();
} catch (error) {
const expected = ['incorrect.md:1:8 MD047/single-trailing-newline Files should end with a single newline character', 'subdir/incorrect.markdown:1:8 MD047/single-trailing-newline Files should end with a single newline character', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr.replaceAll('\\', '/'), expected);
t.is(error.exitCode, 1);
}
});
test('.markdownlintignore works with semi-absolute paths', async t => {
try {
await execa(path.resolve('..', 'markdownlint.js'), ['./incorrect.md'], {
cwd: path.join(__dirname, 'markdownlintignore'),
stripFinalNewline: false
});
t.fail();
} catch (error) {
const expected = ['./incorrect.md:1:8 MD047/single-trailing-newline Files should end with a single newline character', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
}
});
test('--ignore-path works with .markdownlintignore', async t => {
try {
await execa(path.resolve('..', 'markdownlint.js'), ['--ignore-path', '.markdownlintignore', '.'], {
cwd: path.join(__dirname, 'markdownlintignore'),
stripFinalNewline: false
});
t.fail();
} catch (error) {
const expected = ['incorrect.md:1:8 MD047/single-trailing-newline Files should end with a single newline character', 'subdir/incorrect.markdown:1:8 MD047/single-trailing-newline Files should end with a single newline character', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr.replaceAll('\\', '/'), expected);
t.is(error.exitCode, 1);
}
});
test('--ignore-path works with .ignorefile', async t => {
try {
await execa(path.resolve('..', 'markdownlint.js'), ['--ignore-path', '.ignorefile', '.'], {
cwd: path.join(__dirname, 'markdownlintignore'),
stripFinalNewline: false
});
t.fail();
} catch (error) {
const expected = ['incorrect.markdown:1:8 MD047/single-trailing-newline Files should end with a single newline character', ''].join('\n');
t.is(error.stdout, '');
t.is(error.stderr, expected);
t.is(error.exitCode, 1);
}
});
test('--ignore-path fails for missing file', async t => {
const missingFile = 'missing-file';
try {
await execa(path.resolve('..', 'markdownlint.js'), ['--ignore-path', missingFile, '.'], {
cwd: path.join(__dirname, 'markdownlintignore'),
stripFinalNewline: false
});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.regex(error.stderr, /enoent.*no such file or directory/i);
t.is(error.exitCode, 1);
}
});
test('Linter text file --output must end with EOF newline', async t => {
const output = '../outputE.txt';
const endOfLine = new RegExp(os.EOL + '$');
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', '--output', output, 'incorrect.md'], {stripFinalNewline: false});
t.fail();
} catch {
t.regex(fs.readFileSync(output, 'utf8'), endOfLine);
fs.unlinkSync(output);
}
});
test('--dot option to include folders/files with a dot', async t => {
try {
await execa('../markdownlint.js', ['--config', 'test-config.json', '--dot', '**/incorrect-dot.md', '**/.file-with-dot.md', '**/correct.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr.match(errorPattern).length, 11);
t.is(error.exitCode, 1);
}
});
test('without --dot option exclude folders/files with a dot', async t => {
const result = await execa('../markdownlint.js', ['--config', 'test-config.json', '**/incorrect-dot.md', '**/.file-with-dot.md', '**/correct.md'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('with --quiet option does not print to stdout or stderr', async t => {
try {
await execa('../markdownlint.js', ['--quiet', '--config', 'test-config.json', 'incorrect.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr, '');
t.is(error.exitCode, 1);
}
});
test('--enable flag', async t => {
try {
await execa('../markdownlint.js', ['--enable', 'MD041', '--config', 'default-false-config.yml', 'incorrect.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr, 'incorrect.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## header 2"]\n');
t.is(error.exitCode, 1);
}
});
test('--enable flag does not modify already enabled rules', async t => {
try {
await execa('../markdownlint.js', ['--enable', 'MD043', '--config', 'md043-config.yaml', 'correct.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr, 'correct.md:1 MD043/required-headings Required heading structure [Expected: # First; Actual: # header]\n');
t.is(error.exitCode, 1);
}
});
test('--enable flag accepts rule alias', async t => {
try {
await execa('../markdownlint.js', ['--enable', 'first-line-heading', '--config', 'default-false-config.yml', 'incorrect.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr, 'incorrect.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## header 2"]\n');
t.is(error.exitCode, 1);
}
});
test('--disable flag', async t => {
const result = await execa('../markdownlint.js', ['--disable', 'MD014', 'MD022', 'MD041', '--', 'incorrect.md'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
try {
await execa('../markdownlint.js', ['--disable', 'MD014', 'MD014', 'MD022', '--', 'incorrect.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr, 'incorrect.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## header 2"]\n');
t.is(error.exitCode, 1);
}
});
test('--disable flag overrides --enable flag', async t => {
const result = await execa('../markdownlint.js', ['--disable', 'MD041', '--enable', 'MD041', '--config', 'default-false-config.yml', 'incorrect.md'], {stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('configuration can be .js in the CommonJS workspace', async t => {
const result = await execa('../../../markdownlint.js', ['--config', '.markdownlint.js', 'test.md'], {cwd: './workspace/commonjs', stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('configuration can be .cjs in the CommonJS workspace', async t => {
const result = await execa('../../../markdownlint.js', ['--config', '.markdownlint.cjs', 'test.md'], {cwd: './workspace/commonjs', stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});
test('configuration can be .cjs in the ESM (module) workspace', async t => {
const result = await execa('../../../markdownlint.js', ['--config', '.markdownlint.cjs', 'test.md'], {cwd: './workspace/module', stripFinalNewline: false});
t.is(result.stdout, '');
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});