@codacy/tools-markdownlint-0 0.5.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +75 -1
- package/package.json +2 -2
package/dist/index.js
CHANGED
|
@@ -48,6 +48,7 @@ var patterns_default = [
|
|
|
48
48
|
severityLevel: "Info",
|
|
49
49
|
title: "Enforce Incremental Heading Levels",
|
|
50
50
|
enabled: true,
|
|
51
|
+
languages: ["Markdown"],
|
|
51
52
|
parameters: []
|
|
52
53
|
},
|
|
53
54
|
{
|
|
@@ -56,6 +57,7 @@ var patterns_default = [
|
|
|
56
57
|
severityLevel: "Info",
|
|
57
58
|
title: "Enforce Consistent Heading Style",
|
|
58
59
|
enabled: true,
|
|
60
|
+
languages: ["Markdown"],
|
|
59
61
|
parameters: [
|
|
60
62
|
{
|
|
61
63
|
name: "style",
|
|
@@ -70,6 +72,7 @@ var patterns_default = [
|
|
|
70
72
|
severityLevel: "Info",
|
|
71
73
|
title: "Enforce Consistent Unordered List Style",
|
|
72
74
|
enabled: true,
|
|
75
|
+
languages: ["Markdown"],
|
|
73
76
|
parameters: [
|
|
74
77
|
{
|
|
75
78
|
name: "style",
|
|
@@ -84,6 +87,7 @@ var patterns_default = [
|
|
|
84
87
|
severityLevel: "Info",
|
|
85
88
|
title: "Enforce consistent indentation for list items at the same level",
|
|
86
89
|
enabled: true,
|
|
90
|
+
languages: ["Markdown"],
|
|
87
91
|
parameters: []
|
|
88
92
|
},
|
|
89
93
|
{
|
|
@@ -92,6 +96,7 @@ var patterns_default = [
|
|
|
92
96
|
severityLevel: "Info",
|
|
93
97
|
title: "Enforce Unordered List Indentation",
|
|
94
98
|
enabled: true,
|
|
99
|
+
languages: ["Markdown"],
|
|
95
100
|
parameters: [
|
|
96
101
|
{
|
|
97
102
|
name: "indent",
|
|
@@ -116,6 +121,7 @@ var patterns_default = [
|
|
|
116
121
|
severityLevel: "Info",
|
|
117
122
|
title: "Avoid Trailing Spaces",
|
|
118
123
|
enabled: false,
|
|
124
|
+
languages: ["Markdown"],
|
|
119
125
|
parameters: [
|
|
120
126
|
{
|
|
121
127
|
name: "br_spaces",
|
|
@@ -140,6 +146,7 @@ var patterns_default = [
|
|
|
140
146
|
severityLevel: "Info",
|
|
141
147
|
title: "Avoid Hard Tabs",
|
|
142
148
|
enabled: true,
|
|
149
|
+
languages: ["Markdown"],
|
|
143
150
|
parameters: [
|
|
144
151
|
{
|
|
145
152
|
name: "code_blocks",
|
|
@@ -164,6 +171,7 @@ var patterns_default = [
|
|
|
164
171
|
severityLevel: "Warning",
|
|
165
172
|
title: "Avoid Reversed Link Syntax",
|
|
166
173
|
enabled: true,
|
|
174
|
+
languages: ["Markdown"],
|
|
167
175
|
parameters: []
|
|
168
176
|
},
|
|
169
177
|
{
|
|
@@ -172,6 +180,7 @@ var patterns_default = [
|
|
|
172
180
|
severityLevel: "Info",
|
|
173
181
|
title: "Disallow Multiple Consecutive Blank Lines",
|
|
174
182
|
enabled: true,
|
|
183
|
+
languages: ["Markdown"],
|
|
175
184
|
parameters: [
|
|
176
185
|
{
|
|
177
186
|
name: "maximum",
|
|
@@ -186,6 +195,7 @@ var patterns_default = [
|
|
|
186
195
|
severityLevel: "Info",
|
|
187
196
|
title: "Enforce Maximum Line Length",
|
|
188
197
|
enabled: false,
|
|
198
|
+
languages: ["Markdown"],
|
|
189
199
|
parameters: [
|
|
190
200
|
{
|
|
191
201
|
name: "code_block_line_length",
|
|
@@ -235,6 +245,7 @@ var patterns_default = [
|
|
|
235
245
|
severityLevel: "Info",
|
|
236
246
|
title: "Avoid Dollar Signs Before Commands Without Showing Output",
|
|
237
247
|
enabled: true,
|
|
248
|
+
languages: ["Markdown"],
|
|
238
249
|
parameters: []
|
|
239
250
|
},
|
|
240
251
|
{
|
|
@@ -243,6 +254,7 @@ var patterns_default = [
|
|
|
243
254
|
severityLevel: "Info",
|
|
244
255
|
title: "Enforce space after hash in ATX style heading",
|
|
245
256
|
enabled: true,
|
|
257
|
+
languages: ["Markdown"],
|
|
246
258
|
parameters: []
|
|
247
259
|
},
|
|
248
260
|
{
|
|
@@ -251,6 +263,7 @@ var patterns_default = [
|
|
|
251
263
|
severityLevel: "Info",
|
|
252
264
|
title: "Avoid Multiple Spaces After Hash in ATX Style Heading",
|
|
253
265
|
enabled: true,
|
|
266
|
+
languages: ["Markdown"],
|
|
254
267
|
parameters: []
|
|
255
268
|
},
|
|
256
269
|
{
|
|
@@ -259,6 +272,7 @@ var patterns_default = [
|
|
|
259
272
|
severityLevel: "Info",
|
|
260
273
|
title: "Enforce Space Inside Hashes on Closed Atx Style Headings",
|
|
261
274
|
enabled: true,
|
|
275
|
+
languages: ["Markdown"],
|
|
262
276
|
parameters: []
|
|
263
277
|
},
|
|
264
278
|
{
|
|
@@ -267,6 +281,7 @@ var patterns_default = [
|
|
|
267
281
|
severityLevel: "Info",
|
|
268
282
|
title: "Avoid Multiple Spaces Inside Hashes on Closed ATX Style Headings",
|
|
269
283
|
enabled: true,
|
|
284
|
+
languages: ["Markdown"],
|
|
270
285
|
parameters: []
|
|
271
286
|
},
|
|
272
287
|
{
|
|
@@ -275,6 +290,7 @@ var patterns_default = [
|
|
|
275
290
|
severityLevel: "Info",
|
|
276
291
|
title: "Enforce Headings Surrounded by Blank Lines",
|
|
277
292
|
enabled: true,
|
|
293
|
+
languages: ["Markdown"],
|
|
278
294
|
parameters: [
|
|
279
295
|
{
|
|
280
296
|
name: "lines_above",
|
|
@@ -294,6 +310,7 @@ var patterns_default = [
|
|
|
294
310
|
severityLevel: "Info",
|
|
295
311
|
title: "Enforce Headings Start at Beginning of Line",
|
|
296
312
|
enabled: true,
|
|
313
|
+
languages: ["Markdown"],
|
|
297
314
|
parameters: []
|
|
298
315
|
},
|
|
299
316
|
{
|
|
@@ -302,6 +319,7 @@ var patterns_default = [
|
|
|
302
319
|
severityLevel: "Warning",
|
|
303
320
|
title: "Avoid Multiple Headings with the Same Content",
|
|
304
321
|
enabled: true,
|
|
322
|
+
languages: ["Markdown"],
|
|
305
323
|
parameters: [
|
|
306
324
|
{
|
|
307
325
|
name: "siblings_only",
|
|
@@ -316,6 +334,7 @@ var patterns_default = [
|
|
|
316
334
|
severityLevel: "Info",
|
|
317
335
|
title: "Enforce Single Top-Level Heading in Markdown Document",
|
|
318
336
|
enabled: true,
|
|
337
|
+
languages: ["Markdown"],
|
|
319
338
|
parameters: [
|
|
320
339
|
{
|
|
321
340
|
name: "front_matter_title",
|
|
@@ -335,6 +354,7 @@ var patterns_default = [
|
|
|
335
354
|
severityLevel: "Info",
|
|
336
355
|
title: "Avoid Trailing Punctuation in Headings",
|
|
337
356
|
enabled: true,
|
|
357
|
+
languages: ["Markdown"],
|
|
338
358
|
parameters: [
|
|
339
359
|
{
|
|
340
360
|
name: "punctuation",
|
|
@@ -349,6 +369,7 @@ var patterns_default = [
|
|
|
349
369
|
severityLevel: "Info",
|
|
350
370
|
title: "Avoid Multiple Spaces After Blockquote Symbol",
|
|
351
371
|
enabled: true,
|
|
372
|
+
languages: ["Markdown"],
|
|
352
373
|
parameters: []
|
|
353
374
|
},
|
|
354
375
|
{
|
|
@@ -357,6 +378,7 @@ var patterns_default = [
|
|
|
357
378
|
severityLevel: "Info",
|
|
358
379
|
title: "Avoid Blank Line Inside Blockquote",
|
|
359
380
|
enabled: true,
|
|
381
|
+
languages: ["Markdown"],
|
|
360
382
|
parameters: []
|
|
361
383
|
},
|
|
362
384
|
{
|
|
@@ -365,6 +387,7 @@ var patterns_default = [
|
|
|
365
387
|
severityLevel: "Info",
|
|
366
388
|
title: "Enforce Ordered List Item Prefix Consistency",
|
|
367
389
|
enabled: true,
|
|
390
|
+
languages: ["Markdown"],
|
|
368
391
|
parameters: [
|
|
369
392
|
{
|
|
370
393
|
name: "style",
|
|
@@ -379,6 +402,7 @@ var patterns_default = [
|
|
|
379
402
|
severityLevel: "Info",
|
|
380
403
|
title: "Enforce Spaces After List Markers",
|
|
381
404
|
enabled: true,
|
|
405
|
+
languages: ["Markdown"],
|
|
382
406
|
parameters: [
|
|
383
407
|
{
|
|
384
408
|
name: "ol_multi",
|
|
@@ -408,6 +432,7 @@ var patterns_default = [
|
|
|
408
432
|
severityLevel: "Info",
|
|
409
433
|
title: "Enforce blank lines surrounding fenced code blocks",
|
|
410
434
|
enabled: false,
|
|
435
|
+
languages: ["Markdown"],
|
|
411
436
|
parameters: [
|
|
412
437
|
{
|
|
413
438
|
name: "list_items",
|
|
@@ -422,6 +447,7 @@ var patterns_default = [
|
|
|
422
447
|
severityLevel: "Info",
|
|
423
448
|
title: "Enforce Lists Surrounded by Blank Lines",
|
|
424
449
|
enabled: true,
|
|
450
|
+
languages: ["Markdown"],
|
|
425
451
|
parameters: []
|
|
426
452
|
},
|
|
427
453
|
{
|
|
@@ -430,6 +456,7 @@ var patterns_default = [
|
|
|
430
456
|
severityLevel: "Info",
|
|
431
457
|
title: "Disallow Inline HTML in Markdown",
|
|
432
458
|
enabled: true,
|
|
459
|
+
languages: ["Markdown"],
|
|
433
460
|
parameters: [
|
|
434
461
|
{
|
|
435
462
|
name: "allowed_elements",
|
|
@@ -444,6 +471,7 @@ var patterns_default = [
|
|
|
444
471
|
severityLevel: "Info",
|
|
445
472
|
title: "Enforce Angle Brackets Around Bare URLs",
|
|
446
473
|
enabled: true,
|
|
474
|
+
languages: ["Markdown"],
|
|
447
475
|
parameters: []
|
|
448
476
|
},
|
|
449
477
|
{
|
|
@@ -452,6 +480,7 @@ var patterns_default = [
|
|
|
452
480
|
severityLevel: "Info",
|
|
453
481
|
title: "Enforce Consistent Horizontal Rule Style",
|
|
454
482
|
enabled: true,
|
|
483
|
+
languages: ["Markdown"],
|
|
455
484
|
parameters: [
|
|
456
485
|
{
|
|
457
486
|
name: "style",
|
|
@@ -466,6 +495,7 @@ var patterns_default = [
|
|
|
466
495
|
severityLevel: "Info",
|
|
467
496
|
title: "Avoid Using Emphasis Instead of Headings",
|
|
468
497
|
enabled: true,
|
|
498
|
+
languages: ["Markdown"],
|
|
469
499
|
parameters: [
|
|
470
500
|
{
|
|
471
501
|
name: "punctuation",
|
|
@@ -480,6 +510,7 @@ var patterns_default = [
|
|
|
480
510
|
severityLevel: "Info",
|
|
481
511
|
title: "Disallow Spaces Inside Emphasis Markers",
|
|
482
512
|
enabled: true,
|
|
513
|
+
languages: ["Markdown"],
|
|
483
514
|
parameters: []
|
|
484
515
|
},
|
|
485
516
|
{
|
|
@@ -488,6 +519,7 @@ var patterns_default = [
|
|
|
488
519
|
severityLevel: "Info",
|
|
489
520
|
title: "Disallow Spaces Inside Code Span Elements",
|
|
490
521
|
enabled: true,
|
|
522
|
+
languages: ["Markdown"],
|
|
491
523
|
parameters: []
|
|
492
524
|
},
|
|
493
525
|
{
|
|
@@ -496,6 +528,7 @@ var patterns_default = [
|
|
|
496
528
|
severityLevel: "Info",
|
|
497
529
|
title: "Avoid Spaces Inside Link Text",
|
|
498
530
|
enabled: true,
|
|
531
|
+
languages: ["Markdown"],
|
|
499
532
|
parameters: []
|
|
500
533
|
},
|
|
501
534
|
{
|
|
@@ -504,6 +537,7 @@ var patterns_default = [
|
|
|
504
537
|
severityLevel: "Info",
|
|
505
538
|
title: "Enforce language specification in fenced code blocks",
|
|
506
539
|
enabled: false,
|
|
540
|
+
languages: ["Markdown"],
|
|
507
541
|
parameters: [
|
|
508
542
|
{
|
|
509
543
|
name: "allowed_languages",
|
|
@@ -523,6 +557,7 @@ var patterns_default = [
|
|
|
523
557
|
severityLevel: "Info",
|
|
524
558
|
title: "Enforce First Line as Top-Level Heading",
|
|
525
559
|
enabled: false,
|
|
560
|
+
languages: ["Markdown"],
|
|
526
561
|
parameters: [
|
|
527
562
|
{
|
|
528
563
|
name: "front_matter_title",
|
|
@@ -542,6 +577,7 @@ var patterns_default = [
|
|
|
542
577
|
severityLevel: "Info",
|
|
543
578
|
title: "Disallow Empty Links",
|
|
544
579
|
enabled: true,
|
|
580
|
+
languages: ["Markdown"],
|
|
545
581
|
parameters: []
|
|
546
582
|
},
|
|
547
583
|
{
|
|
@@ -550,6 +586,7 @@ var patterns_default = [
|
|
|
550
586
|
severityLevel: "Info",
|
|
551
587
|
title: "Enforce Required Heading Structure",
|
|
552
588
|
enabled: false,
|
|
589
|
+
languages: ["Markdown"],
|
|
553
590
|
parameters: [
|
|
554
591
|
{
|
|
555
592
|
name: "headings",
|
|
@@ -569,6 +606,7 @@ var patterns_default = [
|
|
|
569
606
|
severityLevel: "Info",
|
|
570
607
|
title: "Enforce Proper Capitalization of Proper Names",
|
|
571
608
|
enabled: true,
|
|
609
|
+
languages: ["Markdown"],
|
|
572
610
|
parameters: [
|
|
573
611
|
{
|
|
574
612
|
name: "code_blocks",
|
|
@@ -593,6 +631,7 @@ var patterns_default = [
|
|
|
593
631
|
severityLevel: "Info",
|
|
594
632
|
title: "Enforce Images to Have Alternate Text (alt text)",
|
|
595
633
|
enabled: true,
|
|
634
|
+
languages: ["Markdown"],
|
|
596
635
|
parameters: []
|
|
597
636
|
},
|
|
598
637
|
{
|
|
@@ -601,6 +640,7 @@ var patterns_default = [
|
|
|
601
640
|
severityLevel: "Info",
|
|
602
641
|
title: "Enforce consistent code block style",
|
|
603
642
|
enabled: true,
|
|
643
|
+
languages: ["Markdown"],
|
|
604
644
|
parameters: [
|
|
605
645
|
{
|
|
606
646
|
name: "style",
|
|
@@ -615,6 +655,7 @@ var patterns_default = [
|
|
|
615
655
|
severityLevel: "Info",
|
|
616
656
|
title: "Enforce Single Trailing Newline at End of File",
|
|
617
657
|
enabled: false,
|
|
658
|
+
languages: ["Markdown"],
|
|
618
659
|
parameters: []
|
|
619
660
|
},
|
|
620
661
|
{
|
|
@@ -623,6 +664,7 @@ var patterns_default = [
|
|
|
623
664
|
severityLevel: "Info",
|
|
624
665
|
title: "Enforce Consistent Code Fence Style",
|
|
625
666
|
enabled: true,
|
|
667
|
+
languages: ["Markdown"],
|
|
626
668
|
parameters: [
|
|
627
669
|
{
|
|
628
670
|
name: "style",
|
|
@@ -637,6 +679,7 @@ var patterns_default = [
|
|
|
637
679
|
severityLevel: "Info",
|
|
638
680
|
title: "Enforce Consistent Emphasis Style",
|
|
639
681
|
enabled: true,
|
|
682
|
+
languages: ["Markdown"],
|
|
640
683
|
parameters: [
|
|
641
684
|
{
|
|
642
685
|
name: "style",
|
|
@@ -651,6 +694,7 @@ var patterns_default = [
|
|
|
651
694
|
severityLevel: "Info",
|
|
652
695
|
title: "Enforce Consistent Strong Style",
|
|
653
696
|
enabled: true,
|
|
697
|
+
languages: ["Markdown"],
|
|
654
698
|
parameters: [
|
|
655
699
|
{
|
|
656
700
|
name: "style",
|
|
@@ -665,6 +709,7 @@ var patterns_default = [
|
|
|
665
709
|
severityLevel: "Warning",
|
|
666
710
|
title: "Enforce Valid Link Fragments in Markdown",
|
|
667
711
|
enabled: true,
|
|
712
|
+
languages: ["Markdown"],
|
|
668
713
|
parameters: []
|
|
669
714
|
},
|
|
670
715
|
{
|
|
@@ -673,6 +718,7 @@ var patterns_default = [
|
|
|
673
718
|
severityLevel: "Warning",
|
|
674
719
|
title: "Enforce Defined Labels for Reference Links and Images",
|
|
675
720
|
enabled: true,
|
|
721
|
+
languages: ["Markdown"],
|
|
676
722
|
parameters: [
|
|
677
723
|
{
|
|
678
724
|
name: "shortcut_syntax",
|
|
@@ -687,6 +733,7 @@ var patterns_default = [
|
|
|
687
733
|
severityLevel: "Warning",
|
|
688
734
|
title: "Enforce Link and Image Reference Definitions Are Needed",
|
|
689
735
|
enabled: true,
|
|
736
|
+
languages: ["Markdown"],
|
|
690
737
|
parameters: [
|
|
691
738
|
{
|
|
692
739
|
name: "ignored_definitions",
|
|
@@ -701,6 +748,7 @@ var patterns_default = [
|
|
|
701
748
|
severityLevel: "Info",
|
|
702
749
|
title: "Enforce Consistent Link and Image Style in Markdown",
|
|
703
750
|
enabled: true,
|
|
751
|
+
languages: ["Markdown"],
|
|
704
752
|
parameters: [
|
|
705
753
|
{
|
|
706
754
|
name: "autolink",
|
|
@@ -740,6 +788,7 @@ var patterns_default = [
|
|
|
740
788
|
severityLevel: "Info",
|
|
741
789
|
title: "Enforce Table Pipe Style Consistency",
|
|
742
790
|
enabled: true,
|
|
791
|
+
languages: ["Markdown"],
|
|
743
792
|
parameters: [
|
|
744
793
|
{
|
|
745
794
|
name: "style",
|
|
@@ -754,6 +803,7 @@ var patterns_default = [
|
|
|
754
803
|
severityLevel: "Info",
|
|
755
804
|
title: "Enforce Consistent Table Column Count",
|
|
756
805
|
enabled: true,
|
|
806
|
+
languages: ["Markdown"],
|
|
757
807
|
parameters: []
|
|
758
808
|
}
|
|
759
809
|
];
|
|
@@ -791,12 +841,36 @@ function ruleMetadata(ruleId) {
|
|
|
791
841
|
const patternId = `${TOOL_ID}_${ruleId}`;
|
|
792
842
|
return PATTERN_META.get(patternId) ?? { category: "Documentation", severity: "Info" };
|
|
793
843
|
}
|
|
844
|
+
function coerceParameterValue(value) {
|
|
845
|
+
const trimmed = value.trim();
|
|
846
|
+
if (trimmed === "true") return true;
|
|
847
|
+
if (trimmed === "false") return false;
|
|
848
|
+
if (trimmed.startsWith("[") || trimmed.startsWith("{") || trimmed.startsWith('"')) {
|
|
849
|
+
try {
|
|
850
|
+
return JSON.parse(trimmed);
|
|
851
|
+
} catch {
|
|
852
|
+
return value;
|
|
853
|
+
}
|
|
854
|
+
}
|
|
855
|
+
if (/^-?\d+(\.\d+)?$/.test(trimmed)) {
|
|
856
|
+
return Number(trimmed);
|
|
857
|
+
}
|
|
858
|
+
return value;
|
|
859
|
+
}
|
|
794
860
|
function buildMarkdownlintConfig(patterns) {
|
|
795
861
|
const config = { default: false };
|
|
796
862
|
const prefix = `${TOOL_ID}_`;
|
|
797
863
|
for (const p of patterns) {
|
|
798
864
|
const ruleId = p.patternId.startsWith(prefix) ? p.patternId.slice(prefix.length) : p.patternId;
|
|
799
|
-
|
|
865
|
+
if (p.parameters && Object.keys(p.parameters).length > 0) {
|
|
866
|
+
const coerced = {};
|
|
867
|
+
for (const [key, value] of Object.entries(p.parameters)) {
|
|
868
|
+
coerced[key] = coerceParameterValue(value);
|
|
869
|
+
}
|
|
870
|
+
config[ruleId] = coerced;
|
|
871
|
+
} else {
|
|
872
|
+
config[ruleId] = true;
|
|
873
|
+
}
|
|
800
874
|
}
|
|
801
875
|
return config;
|
|
802
876
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@codacy/tools-markdownlint-0",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0",
|
|
4
4
|
"description": "markdownlint adapter — Library-mode Markdown linter",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
],
|
|
10
10
|
"dependencies": {
|
|
11
11
|
"markdownlint": "^0.37.4",
|
|
12
|
-
"@codacy/tooling": "0.
|
|
12
|
+
"@codacy/tooling": "0.6.0"
|
|
13
13
|
},
|
|
14
14
|
"license": "MIT",
|
|
15
15
|
"author": "Codacy <support@codacy.com> (https://www.codacy.com)",
|