@brnshkr/config 0.0.1-beta.3 → 0.0.1-beta.4

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.
Files changed (37) hide show
  1. package/README.md +174 -226
  2. package/conf/.gitignore.dist +15 -0
  3. package/conf/Makefile +3778 -0
  4. package/conf/Makefile.dist +13 -0
  5. package/conf/bunfig.dist.toml +5 -0
  6. package/conf/commitlint.dist.mjs +1 -0
  7. package/conf/editorconfig.dist +19 -0
  8. package/conf/launch.dist.json +31 -0
  9. package/conf/markdownlint.dist.mjs +1 -0
  10. package/conf/spelling/defaults.json +185 -0
  11. package/conf/tsconfig.dist.json +3 -0
  12. package/conf/tsconfig.json +31 -27
  13. package/conf/vitest.dist.mjs +1 -0
  14. package/conf/vscode-css-custom-data.dist.json +95 -0
  15. package/conf/vscode-extensions.dist.json +21 -0
  16. package/conf/vscode-settings.dist.jsonc +338 -0
  17. package/dist/commitlint/index.d.mts +72 -0
  18. package/dist/commitlint/index.mjs +239 -0
  19. package/dist/eslint/index.d.mts +3890 -1387
  20. package/dist/eslint/index.mjs +2662 -471
  21. package/dist/markdownlint/index.d.mts +2304 -0
  22. package/dist/markdownlint/index.mjs +440 -0
  23. package/dist/shared.mjs +406 -64
  24. package/dist/spelling/index.d.mts +30 -0
  25. package/dist/spelling/index.mjs +2 -0
  26. package/dist/spelling/spelling.test.d.mts +1 -0
  27. package/dist/spelling/spelling.test.mjs +12 -0
  28. package/dist/stylelint/index.d.mts +47 -9
  29. package/dist/stylelint/index.mjs +145 -47
  30. package/dist/vitest/index.d.mts +73 -0
  31. package/dist/vitest/index.mjs +181 -0
  32. package/package.json +192 -105
  33. package/conf/tsconfig.json.example +0 -3
  34. package/dist/scripts/eslint.mjs +0 -16
  35. package/dist/scripts/stylelint.mjs +0 -31
  36. /package/conf/{eslint.config.mjs.example → eslint.dist.mjs} +0 -0
  37. /package/conf/{stylelint.config.mjs.example → stylelint.dist.mjs} +0 -0
@@ -0,0 +1,2304 @@
1
+ import { FencedCodeFenceLengthConfig, HeadingSentenceCaseConfig, ListItemMarkerSpaceConfig, SetextHeadingBlankLinesConfig } from "@hongminhee/markdownlint-rules";
2
+ //#region ../src/js/markdownlint/types/declarations/typegen.d.ts
3
+ interface Config$1 {
4
+ /**
5
+ * JSON Schema URI (expected by some editors)
6
+ */
7
+ $schema?: string;
8
+ config?: Rules$1;
9
+ /**
10
+ * Module names or paths of custom rules to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
11
+ *
12
+ * Items: Module name or path of a custom rule
13
+ */
14
+ customRules?: string[];
15
+ /**
16
+ * Whether to enable fixing of linting errors reported by rules that emit fix information : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
17
+ */
18
+ fix?: boolean;
19
+ /**
20
+ * Regular expression used to match and ignore any front matter at the beginning of a document : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
21
+ */
22
+ frontMatter?: string;
23
+ /**
24
+ * Whether to ignore files referenced by .gitignore (or glob expression) (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
25
+ */
26
+ gitignore?: boolean | string;
27
+ /**
28
+ * Glob expressions to include when linting (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
29
+ *
30
+ * Items: Glob expression of files to lint
31
+ */
32
+ globs?: string[];
33
+ /**
34
+ * Glob expressions to ignore when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
35
+ *
36
+ * Items: Glob expression of files to ignore
37
+ */
38
+ ignores?: string[];
39
+ /**
40
+ * markdown-it plugins to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
41
+ */
42
+ markdownItPlugins?: [] | [string] | [string, {
43
+ [k: string]: unknown;
44
+ }][];
45
+ /**
46
+ * Additional paths to resolve module locations from : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
47
+ *
48
+ * Items: Path to resolve module locations from
49
+ */
50
+ modulePaths?: string[];
51
+ /**
52
+ * Whether to disable the display of the banner message and version numbers on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
53
+ */
54
+ noBanner?: boolean;
55
+ /**
56
+ * Whether to disable support of HTML comments within Markdown content : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
57
+ */
58
+ noInlineConfig?: boolean;
59
+ /**
60
+ * Whether to disable the display of progress on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
61
+ */
62
+ noProgress?: boolean;
63
+ /**
64
+ * Output formatters to load and use to customize markdownlint-cli2 output (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
65
+ */
66
+ outputFormatters?: [] | [string] | [string, {
67
+ [k: string]: unknown;
68
+ }][];
69
+ /**
70
+ * Configuration overrides : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
71
+ *
72
+ * Items: Configuration override
73
+ */
74
+ overrides?: {
75
+ /**
76
+ * Glob expression(s) of files for which override applies
77
+ *
78
+ * Items: Glob expression
79
+ */
80
+ filter: string[];
81
+ config: Rules$1;
82
+ /**
83
+ * Strategy for combining override config with parent config
84
+ */
85
+ combine?: 'merge' | 'replace';
86
+ }[];
87
+ /**
88
+ * Whether to show the list of found files on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.23.2/README.md#markdownlint-cli2jsonc
89
+ */
90
+ showFound?: boolean;
91
+ }
92
+ interface Rules$1 {
93
+ /**
94
+ * JSON Schema URI (expected by some editors)
95
+ */
96
+ $schema?: string;
97
+ /**
98
+ * Default state for all rules
99
+ */
100
+ default?: boolean | ('error' | 'warning');
101
+ /**
102
+ * Path to configuration file to extend
103
+ */
104
+ extends?: string | null;
105
+ /**
106
+ * MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md001.md
107
+ */
108
+ MD001?: boolean | ('error' | 'warning') | {
109
+ /**
110
+ * Whether to enable the rule
111
+ */
112
+ enabled?: boolean;
113
+ /**
114
+ * Rule severity
115
+ */
116
+ severity?: 'error' | 'warning';
117
+ /**
118
+ * RegExp for matching title in front matter
119
+ */
120
+ front_matter_title?: string;
121
+ };
122
+ /**
123
+ * MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md001.md
124
+ */
125
+ 'heading-increment'?: boolean | ('error' | 'warning') | {
126
+ /**
127
+ * Whether to enable the rule
128
+ */
129
+ enabled?: boolean;
130
+ /**
131
+ * Rule severity
132
+ */
133
+ severity?: 'error' | 'warning';
134
+ /**
135
+ * RegExp for matching title in front matter
136
+ */
137
+ front_matter_title?: string;
138
+ };
139
+ /**
140
+ * MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md003.md
141
+ */
142
+ MD003?: boolean | ('error' | 'warning') | {
143
+ /**
144
+ * Whether to enable the rule
145
+ */
146
+ enabled?: boolean;
147
+ /**
148
+ * Rule severity
149
+ */
150
+ severity?: 'error' | 'warning';
151
+ /**
152
+ * Heading style
153
+ */
154
+ style?: 'consistent' | 'atx' | 'atx_closed' | 'setext' | 'setext_with_atx' | 'setext_with_atx_closed';
155
+ };
156
+ /**
157
+ * MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md003.md
158
+ */
159
+ 'heading-style'?: boolean | ('error' | 'warning') | {
160
+ /**
161
+ * Whether to enable the rule
162
+ */
163
+ enabled?: boolean;
164
+ /**
165
+ * Rule severity
166
+ */
167
+ severity?: 'error' | 'warning';
168
+ /**
169
+ * Heading style
170
+ */
171
+ style?: 'consistent' | 'atx' | 'atx_closed' | 'setext' | 'setext_with_atx' | 'setext_with_atx_closed';
172
+ };
173
+ /**
174
+ * MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md004.md
175
+ */
176
+ MD004?: boolean | ('error' | 'warning') | {
177
+ /**
178
+ * Whether to enable the rule
179
+ */
180
+ enabled?: boolean;
181
+ /**
182
+ * Rule severity
183
+ */
184
+ severity?: 'error' | 'warning';
185
+ /**
186
+ * List style
187
+ */
188
+ style?: 'consistent' | 'asterisk' | 'plus' | 'dash' | 'sublist';
189
+ };
190
+ /**
191
+ * MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md004.md
192
+ */
193
+ 'ul-style'?: boolean | ('error' | 'warning') | {
194
+ /**
195
+ * Whether to enable the rule
196
+ */
197
+ enabled?: boolean;
198
+ /**
199
+ * Rule severity
200
+ */
201
+ severity?: 'error' | 'warning';
202
+ /**
203
+ * List style
204
+ */
205
+ style?: 'consistent' | 'asterisk' | 'plus' | 'dash' | 'sublist';
206
+ };
207
+ /**
208
+ * MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md005.md
209
+ */
210
+ MD005?: boolean | ('error' | 'warning') | {
211
+ /**
212
+ * Whether to enable the rule
213
+ */
214
+ enabled?: boolean;
215
+ /**
216
+ * Rule severity
217
+ */
218
+ severity?: 'error' | 'warning';
219
+ };
220
+ /**
221
+ * MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md005.md
222
+ */
223
+ 'list-indent'?: boolean | ('error' | 'warning') | {
224
+ /**
225
+ * Whether to enable the rule
226
+ */
227
+ enabled?: boolean;
228
+ /**
229
+ * Rule severity
230
+ */
231
+ severity?: 'error' | 'warning';
232
+ };
233
+ /**
234
+ * MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md007.md
235
+ */
236
+ MD007?: boolean | ('error' | 'warning') | {
237
+ /**
238
+ * Whether to enable the rule
239
+ */
240
+ enabled?: boolean;
241
+ /**
242
+ * Rule severity
243
+ */
244
+ severity?: 'error' | 'warning';
245
+ /**
246
+ * Spaces for indent
247
+ */
248
+ indent?: number;
249
+ /**
250
+ * Whether to indent the first level of the list
251
+ */
252
+ start_indented?: boolean;
253
+ /**
254
+ * Spaces for first level indent (when start_indented is set)
255
+ */
256
+ start_indent?: number;
257
+ };
258
+ /**
259
+ * MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md007.md
260
+ */
261
+ 'ul-indent'?: boolean | ('error' | 'warning') | {
262
+ /**
263
+ * Whether to enable the rule
264
+ */
265
+ enabled?: boolean;
266
+ /**
267
+ * Rule severity
268
+ */
269
+ severity?: 'error' | 'warning';
270
+ /**
271
+ * Spaces for indent
272
+ */
273
+ indent?: number;
274
+ /**
275
+ * Whether to indent the first level of the list
276
+ */
277
+ start_indented?: boolean;
278
+ /**
279
+ * Spaces for first level indent (when start_indented is set)
280
+ */
281
+ start_indent?: number;
282
+ };
283
+ /**
284
+ * MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md009.md
285
+ */
286
+ MD009?: boolean | ('error' | 'warning') | {
287
+ /**
288
+ * Whether to enable the rule
289
+ */
290
+ enabled?: boolean;
291
+ /**
292
+ * Rule severity
293
+ */
294
+ severity?: 'error' | 'warning';
295
+ /**
296
+ * Spaces for line break
297
+ */
298
+ br_spaces?: number;
299
+ /**
300
+ * Include code blocks
301
+ */
302
+ code_blocks?: boolean;
303
+ /**
304
+ * Allow spaces for empty lines in list items
305
+ */
306
+ list_item_empty_lines?: boolean;
307
+ /**
308
+ * Include unnecessary breaks
309
+ */
310
+ strict?: boolean;
311
+ };
312
+ /**
313
+ * MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md009.md
314
+ */
315
+ 'no-trailing-spaces'?: boolean | ('error' | 'warning') | {
316
+ /**
317
+ * Whether to enable the rule
318
+ */
319
+ enabled?: boolean;
320
+ /**
321
+ * Rule severity
322
+ */
323
+ severity?: 'error' | 'warning';
324
+ /**
325
+ * Spaces for line break
326
+ */
327
+ br_spaces?: number;
328
+ /**
329
+ * Include code blocks
330
+ */
331
+ code_blocks?: boolean;
332
+ /**
333
+ * Allow spaces for empty lines in list items
334
+ */
335
+ list_item_empty_lines?: boolean;
336
+ /**
337
+ * Include unnecessary breaks
338
+ */
339
+ strict?: boolean;
340
+ };
341
+ /**
342
+ * MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md010.md
343
+ */
344
+ MD010?: boolean | ('error' | 'warning') | {
345
+ /**
346
+ * Whether to enable the rule
347
+ */
348
+ enabled?: boolean;
349
+ /**
350
+ * Rule severity
351
+ */
352
+ severity?: 'error' | 'warning';
353
+ /**
354
+ * Include code blocks
355
+ */
356
+ code_blocks?: boolean;
357
+ /**
358
+ * Fenced code languages to ignore
359
+ */
360
+ ignore_code_languages?: string[];
361
+ /**
362
+ * Number of spaces for each hard tab
363
+ */
364
+ spaces_per_tab?: number;
365
+ };
366
+ /**
367
+ * MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md010.md
368
+ */
369
+ 'no-hard-tabs'?: boolean | ('error' | 'warning') | {
370
+ /**
371
+ * Whether to enable the rule
372
+ */
373
+ enabled?: boolean;
374
+ /**
375
+ * Rule severity
376
+ */
377
+ severity?: 'error' | 'warning';
378
+ /**
379
+ * Include code blocks
380
+ */
381
+ code_blocks?: boolean;
382
+ /**
383
+ * Fenced code languages to ignore
384
+ */
385
+ ignore_code_languages?: string[];
386
+ /**
387
+ * Number of spaces for each hard tab
388
+ */
389
+ spaces_per_tab?: number;
390
+ };
391
+ /**
392
+ * MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md011.md
393
+ */
394
+ MD011?: boolean | ('error' | 'warning') | {
395
+ /**
396
+ * Whether to enable the rule
397
+ */
398
+ enabled?: boolean;
399
+ /**
400
+ * Rule severity
401
+ */
402
+ severity?: 'error' | 'warning';
403
+ };
404
+ /**
405
+ * MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md011.md
406
+ */
407
+ 'no-reversed-links'?: boolean | ('error' | 'warning') | {
408
+ /**
409
+ * Whether to enable the rule
410
+ */
411
+ enabled?: boolean;
412
+ /**
413
+ * Rule severity
414
+ */
415
+ severity?: 'error' | 'warning';
416
+ };
417
+ /**
418
+ * MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md012.md
419
+ */
420
+ MD012?: boolean | ('error' | 'warning') | {
421
+ /**
422
+ * Whether to enable the rule
423
+ */
424
+ enabled?: boolean;
425
+ /**
426
+ * Rule severity
427
+ */
428
+ severity?: 'error' | 'warning';
429
+ /**
430
+ * Consecutive blank lines
431
+ */
432
+ maximum?: number;
433
+ };
434
+ /**
435
+ * MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md012.md
436
+ */
437
+ 'no-multiple-blanks'?: boolean | ('error' | 'warning') | {
438
+ /**
439
+ * Whether to enable the rule
440
+ */
441
+ enabled?: boolean;
442
+ /**
443
+ * Rule severity
444
+ */
445
+ severity?: 'error' | 'warning';
446
+ /**
447
+ * Consecutive blank lines
448
+ */
449
+ maximum?: number;
450
+ };
451
+ /**
452
+ * MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md013.md
453
+ */
454
+ MD013?: boolean | ('error' | 'warning') | {
455
+ /**
456
+ * Whether to enable the rule
457
+ */
458
+ enabled?: boolean;
459
+ /**
460
+ * Rule severity
461
+ */
462
+ severity?: 'error' | 'warning';
463
+ /**
464
+ * Number of characters
465
+ */
466
+ line_length?: number;
467
+ /**
468
+ * Number of characters for headings
469
+ */
470
+ heading_line_length?: number;
471
+ /**
472
+ * Number of characters for code blocks
473
+ */
474
+ code_block_line_length?: number;
475
+ /**
476
+ * Include code blocks
477
+ */
478
+ code_blocks?: boolean;
479
+ /**
480
+ * Include tables
481
+ */
482
+ tables?: boolean;
483
+ /**
484
+ * Include headings
485
+ */
486
+ headings?: boolean;
487
+ /**
488
+ * Strict length checking
489
+ */
490
+ strict?: boolean;
491
+ /**
492
+ * Stern length checking
493
+ */
494
+ stern?: boolean;
495
+ };
496
+ /**
497
+ * MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md013.md
498
+ */
499
+ 'line-length'?: boolean | ('error' | 'warning') | {
500
+ /**
501
+ * Whether to enable the rule
502
+ */
503
+ enabled?: boolean;
504
+ /**
505
+ * Rule severity
506
+ */
507
+ severity?: 'error' | 'warning';
508
+ /**
509
+ * Number of characters
510
+ */
511
+ line_length?: number;
512
+ /**
513
+ * Number of characters for headings
514
+ */
515
+ heading_line_length?: number;
516
+ /**
517
+ * Number of characters for code blocks
518
+ */
519
+ code_block_line_length?: number;
520
+ /**
521
+ * Include code blocks
522
+ */
523
+ code_blocks?: boolean;
524
+ /**
525
+ * Include tables
526
+ */
527
+ tables?: boolean;
528
+ /**
529
+ * Include headings
530
+ */
531
+ headings?: boolean;
532
+ /**
533
+ * Strict length checking
534
+ */
535
+ strict?: boolean;
536
+ /**
537
+ * Stern length checking
538
+ */
539
+ stern?: boolean;
540
+ };
541
+ /**
542
+ * MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md014.md
543
+ */
544
+ MD014?: boolean | ('error' | 'warning') | {
545
+ /**
546
+ * Whether to enable the rule
547
+ */
548
+ enabled?: boolean;
549
+ /**
550
+ * Rule severity
551
+ */
552
+ severity?: 'error' | 'warning';
553
+ };
554
+ /**
555
+ * MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md014.md
556
+ */
557
+ 'commands-show-output'?: boolean | ('error' | 'warning') | {
558
+ /**
559
+ * Whether to enable the rule
560
+ */
561
+ enabled?: boolean;
562
+ /**
563
+ * Rule severity
564
+ */
565
+ severity?: 'error' | 'warning';
566
+ };
567
+ /**
568
+ * MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md018.md
569
+ */
570
+ MD018?: boolean | ('error' | 'warning') | {
571
+ /**
572
+ * Whether to enable the rule
573
+ */
574
+ enabled?: boolean;
575
+ /**
576
+ * Rule severity
577
+ */
578
+ severity?: 'error' | 'warning';
579
+ };
580
+ /**
581
+ * MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md018.md
582
+ */
583
+ 'no-missing-space-atx'?: boolean | ('error' | 'warning') | {
584
+ /**
585
+ * Whether to enable the rule
586
+ */
587
+ enabled?: boolean;
588
+ /**
589
+ * Rule severity
590
+ */
591
+ severity?: 'error' | 'warning';
592
+ };
593
+ /**
594
+ * MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md019.md
595
+ */
596
+ MD019?: boolean | ('error' | 'warning') | {
597
+ /**
598
+ * Whether to enable the rule
599
+ */
600
+ enabled?: boolean;
601
+ /**
602
+ * Rule severity
603
+ */
604
+ severity?: 'error' | 'warning';
605
+ };
606
+ /**
607
+ * MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md019.md
608
+ */
609
+ 'no-multiple-space-atx'?: boolean | ('error' | 'warning') | {
610
+ /**
611
+ * Whether to enable the rule
612
+ */
613
+ enabled?: boolean;
614
+ /**
615
+ * Rule severity
616
+ */
617
+ severity?: 'error' | 'warning';
618
+ };
619
+ /**
620
+ * MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md020.md
621
+ */
622
+ MD020?: boolean | ('error' | 'warning') | {
623
+ /**
624
+ * Whether to enable the rule
625
+ */
626
+ enabled?: boolean;
627
+ /**
628
+ * Rule severity
629
+ */
630
+ severity?: 'error' | 'warning';
631
+ };
632
+ /**
633
+ * MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md020.md
634
+ */
635
+ 'no-missing-space-closed-atx'?: boolean | ('error' | 'warning') | {
636
+ /**
637
+ * Whether to enable the rule
638
+ */
639
+ enabled?: boolean;
640
+ /**
641
+ * Rule severity
642
+ */
643
+ severity?: 'error' | 'warning';
644
+ };
645
+ /**
646
+ * MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md021.md
647
+ */
648
+ MD021?: boolean | ('error' | 'warning') | {
649
+ /**
650
+ * Whether to enable the rule
651
+ */
652
+ enabled?: boolean;
653
+ /**
654
+ * Rule severity
655
+ */
656
+ severity?: 'error' | 'warning';
657
+ };
658
+ /**
659
+ * MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md021.md
660
+ */
661
+ 'no-multiple-space-closed-atx'?: boolean | ('error' | 'warning') | {
662
+ /**
663
+ * Whether to enable the rule
664
+ */
665
+ enabled?: boolean;
666
+ /**
667
+ * Rule severity
668
+ */
669
+ severity?: 'error' | 'warning';
670
+ };
671
+ /**
672
+ * MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md022.md
673
+ */
674
+ MD022?: boolean | ('error' | 'warning') | {
675
+ /**
676
+ * Whether to enable the rule
677
+ */
678
+ enabled?: boolean;
679
+ /**
680
+ * Rule severity
681
+ */
682
+ severity?: 'error' | 'warning';
683
+ /**
684
+ * Include front matter content
685
+ */
686
+ include_front_matter?: boolean;
687
+ /**
688
+ * Blank lines above heading
689
+ */
690
+ lines_above?: number | number[];
691
+ /**
692
+ * Blank lines below heading
693
+ */
694
+ lines_below?: number | number[];
695
+ };
696
+ /**
697
+ * MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md022.md
698
+ */
699
+ 'blanks-around-headings'?: boolean | ('error' | 'warning') | {
700
+ /**
701
+ * Whether to enable the rule
702
+ */
703
+ enabled?: boolean;
704
+ /**
705
+ * Rule severity
706
+ */
707
+ severity?: 'error' | 'warning';
708
+ /**
709
+ * Include front matter content
710
+ */
711
+ include_front_matter?: boolean;
712
+ /**
713
+ * Blank lines above heading
714
+ */
715
+ lines_above?: number | number[];
716
+ /**
717
+ * Blank lines below heading
718
+ */
719
+ lines_below?: number | number[];
720
+ };
721
+ /**
722
+ * MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md023.md
723
+ */
724
+ MD023?: boolean | ('error' | 'warning') | {
725
+ /**
726
+ * Whether to enable the rule
727
+ */
728
+ enabled?: boolean;
729
+ /**
730
+ * Rule severity
731
+ */
732
+ severity?: 'error' | 'warning';
733
+ };
734
+ /**
735
+ * MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md023.md
736
+ */
737
+ 'heading-start-left'?: boolean | ('error' | 'warning') | {
738
+ /**
739
+ * Whether to enable the rule
740
+ */
741
+ enabled?: boolean;
742
+ /**
743
+ * Rule severity
744
+ */
745
+ severity?: 'error' | 'warning';
746
+ };
747
+ /**
748
+ * MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md024.md
749
+ */
750
+ MD024?: boolean | ('error' | 'warning') | {
751
+ /**
752
+ * Whether to enable the rule
753
+ */
754
+ enabled?: boolean;
755
+ /**
756
+ * Rule severity
757
+ */
758
+ severity?: 'error' | 'warning';
759
+ /**
760
+ * Only check sibling headings
761
+ */
762
+ siblings_only?: boolean;
763
+ };
764
+ /**
765
+ * MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md024.md
766
+ */
767
+ 'no-duplicate-heading'?: boolean | ('error' | 'warning') | {
768
+ /**
769
+ * Whether to enable the rule
770
+ */
771
+ enabled?: boolean;
772
+ /**
773
+ * Rule severity
774
+ */
775
+ severity?: 'error' | 'warning';
776
+ /**
777
+ * Only check sibling headings
778
+ */
779
+ siblings_only?: boolean;
780
+ };
781
+ /**
782
+ * MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md025.md
783
+ */
784
+ MD025?: boolean | ('error' | 'warning') | {
785
+ /**
786
+ * Whether to enable the rule
787
+ */
788
+ enabled?: boolean;
789
+ /**
790
+ * Rule severity
791
+ */
792
+ severity?: 'error' | 'warning';
793
+ /**
794
+ * RegExp for matching title in front matter
795
+ */
796
+ front_matter_title?: string;
797
+ /**
798
+ * Heading level
799
+ */
800
+ level?: number;
801
+ };
802
+ /**
803
+ * MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md025.md
804
+ */
805
+ 'single-title'?: boolean | ('error' | 'warning') | {
806
+ /**
807
+ * Whether to enable the rule
808
+ */
809
+ enabled?: boolean;
810
+ /**
811
+ * Rule severity
812
+ */
813
+ severity?: 'error' | 'warning';
814
+ /**
815
+ * RegExp for matching title in front matter
816
+ */
817
+ front_matter_title?: string;
818
+ /**
819
+ * Heading level
820
+ */
821
+ level?: number;
822
+ };
823
+ /**
824
+ * MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md025.md
825
+ */
826
+ 'single-h1'?: boolean | ('error' | 'warning') | {
827
+ /**
828
+ * Whether to enable the rule
829
+ */
830
+ enabled?: boolean;
831
+ /**
832
+ * Rule severity
833
+ */
834
+ severity?: 'error' | 'warning';
835
+ /**
836
+ * RegExp for matching title in front matter
837
+ */
838
+ front_matter_title?: string;
839
+ /**
840
+ * Heading level
841
+ */
842
+ level?: number;
843
+ };
844
+ /**
845
+ * MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md026.md
846
+ */
847
+ MD026?: boolean | ('error' | 'warning') | {
848
+ /**
849
+ * Whether to enable the rule
850
+ */
851
+ enabled?: boolean;
852
+ /**
853
+ * Rule severity
854
+ */
855
+ severity?: 'error' | 'warning';
856
+ /**
857
+ * Punctuation characters
858
+ */
859
+ punctuation?: string;
860
+ };
861
+ /**
862
+ * MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md026.md
863
+ */
864
+ 'no-trailing-punctuation'?: boolean | ('error' | 'warning') | {
865
+ /**
866
+ * Whether to enable the rule
867
+ */
868
+ enabled?: boolean;
869
+ /**
870
+ * Rule severity
871
+ */
872
+ severity?: 'error' | 'warning';
873
+ /**
874
+ * Punctuation characters
875
+ */
876
+ punctuation?: string;
877
+ };
878
+ /**
879
+ * MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md027.md
880
+ */
881
+ MD027?: boolean | ('error' | 'warning') | {
882
+ /**
883
+ * Whether to enable the rule
884
+ */
885
+ enabled?: boolean;
886
+ /**
887
+ * Rule severity
888
+ */
889
+ severity?: 'error' | 'warning';
890
+ /**
891
+ * Include list items
892
+ */
893
+ list_items?: boolean;
894
+ };
895
+ /**
896
+ * MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md027.md
897
+ */
898
+ 'no-multiple-space-blockquote'?: boolean | ('error' | 'warning') | {
899
+ /**
900
+ * Whether to enable the rule
901
+ */
902
+ enabled?: boolean;
903
+ /**
904
+ * Rule severity
905
+ */
906
+ severity?: 'error' | 'warning';
907
+ /**
908
+ * Include list items
909
+ */
910
+ list_items?: boolean;
911
+ };
912
+ /**
913
+ * MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md028.md
914
+ */
915
+ MD028?: boolean | ('error' | 'warning') | {
916
+ /**
917
+ * Whether to enable the rule
918
+ */
919
+ enabled?: boolean;
920
+ /**
921
+ * Rule severity
922
+ */
923
+ severity?: 'error' | 'warning';
924
+ };
925
+ /**
926
+ * MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md028.md
927
+ */
928
+ 'no-blanks-blockquote'?: boolean | ('error' | 'warning') | {
929
+ /**
930
+ * Whether to enable the rule
931
+ */
932
+ enabled?: boolean;
933
+ /**
934
+ * Rule severity
935
+ */
936
+ severity?: 'error' | 'warning';
937
+ };
938
+ /**
939
+ * MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md029.md
940
+ */
941
+ MD029?: boolean | ('error' | 'warning') | {
942
+ /**
943
+ * Whether to enable the rule
944
+ */
945
+ enabled?: boolean;
946
+ /**
947
+ * Rule severity
948
+ */
949
+ severity?: 'error' | 'warning';
950
+ /**
951
+ * List style
952
+ */
953
+ style?: 'one' | 'ordered' | 'one_or_ordered' | 'zero';
954
+ };
955
+ /**
956
+ * MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md029.md
957
+ */
958
+ 'ol-prefix'?: boolean | ('error' | 'warning') | {
959
+ /**
960
+ * Whether to enable the rule
961
+ */
962
+ enabled?: boolean;
963
+ /**
964
+ * Rule severity
965
+ */
966
+ severity?: 'error' | 'warning';
967
+ /**
968
+ * List style
969
+ */
970
+ style?: 'one' | 'ordered' | 'one_or_ordered' | 'zero';
971
+ };
972
+ /**
973
+ * MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md030.md
974
+ */
975
+ MD030?: boolean | ('error' | 'warning') | {
976
+ /**
977
+ * Whether to enable the rule
978
+ */
979
+ enabled?: boolean;
980
+ /**
981
+ * Rule severity
982
+ */
983
+ severity?: 'error' | 'warning';
984
+ /**
985
+ * Spaces for single-line unordered list items
986
+ */
987
+ ul_single?: number;
988
+ /**
989
+ * Spaces for single-line ordered list items
990
+ */
991
+ ol_single?: number;
992
+ /**
993
+ * Spaces for multi-line unordered list items
994
+ */
995
+ ul_multi?: number;
996
+ /**
997
+ * Spaces for multi-line ordered list items
998
+ */
999
+ ol_multi?: number;
1000
+ };
1001
+ /**
1002
+ * MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md030.md
1003
+ */
1004
+ 'list-marker-space'?: boolean | ('error' | 'warning') | {
1005
+ /**
1006
+ * Whether to enable the rule
1007
+ */
1008
+ enabled?: boolean;
1009
+ /**
1010
+ * Rule severity
1011
+ */
1012
+ severity?: 'error' | 'warning';
1013
+ /**
1014
+ * Spaces for single-line unordered list items
1015
+ */
1016
+ ul_single?: number;
1017
+ /**
1018
+ * Spaces for single-line ordered list items
1019
+ */
1020
+ ol_single?: number;
1021
+ /**
1022
+ * Spaces for multi-line unordered list items
1023
+ */
1024
+ ul_multi?: number;
1025
+ /**
1026
+ * Spaces for multi-line ordered list items
1027
+ */
1028
+ ol_multi?: number;
1029
+ };
1030
+ /**
1031
+ * MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md031.md
1032
+ */
1033
+ MD031?: boolean | ('error' | 'warning') | {
1034
+ /**
1035
+ * Whether to enable the rule
1036
+ */
1037
+ enabled?: boolean;
1038
+ /**
1039
+ * Rule severity
1040
+ */
1041
+ severity?: 'error' | 'warning';
1042
+ /**
1043
+ * Include list items
1044
+ */
1045
+ list_items?: boolean;
1046
+ };
1047
+ /**
1048
+ * MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md031.md
1049
+ */
1050
+ 'blanks-around-fences'?: boolean | ('error' | 'warning') | {
1051
+ /**
1052
+ * Whether to enable the rule
1053
+ */
1054
+ enabled?: boolean;
1055
+ /**
1056
+ * Rule severity
1057
+ */
1058
+ severity?: 'error' | 'warning';
1059
+ /**
1060
+ * Include list items
1061
+ */
1062
+ list_items?: boolean;
1063
+ };
1064
+ /**
1065
+ * MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md032.md
1066
+ */
1067
+ MD032?: boolean | ('error' | 'warning') | {
1068
+ /**
1069
+ * Whether to enable the rule
1070
+ */
1071
+ enabled?: boolean;
1072
+ /**
1073
+ * Rule severity
1074
+ */
1075
+ severity?: 'error' | 'warning';
1076
+ };
1077
+ /**
1078
+ * MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md032.md
1079
+ */
1080
+ 'blanks-around-lists'?: boolean | ('error' | 'warning') | {
1081
+ /**
1082
+ * Whether to enable the rule
1083
+ */
1084
+ enabled?: boolean;
1085
+ /**
1086
+ * Rule severity
1087
+ */
1088
+ severity?: 'error' | 'warning';
1089
+ };
1090
+ /**
1091
+ * MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md033.md
1092
+ */
1093
+ MD033?: boolean | ('error' | 'warning') | {
1094
+ /**
1095
+ * Whether to enable the rule
1096
+ */
1097
+ enabled?: boolean;
1098
+ /**
1099
+ * Rule severity
1100
+ */
1101
+ severity?: 'error' | 'warning';
1102
+ /**
1103
+ * Allowed elements
1104
+ */
1105
+ allowed_elements?: string[];
1106
+ /**
1107
+ * Allowed elements in tables
1108
+ */
1109
+ table_allowed_elements?: string[];
1110
+ };
1111
+ /**
1112
+ * MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md033.md
1113
+ */
1114
+ 'no-inline-html'?: boolean | ('error' | 'warning') | {
1115
+ /**
1116
+ * Whether to enable the rule
1117
+ */
1118
+ enabled?: boolean;
1119
+ /**
1120
+ * Rule severity
1121
+ */
1122
+ severity?: 'error' | 'warning';
1123
+ /**
1124
+ * Allowed elements
1125
+ */
1126
+ allowed_elements?: string[];
1127
+ /**
1128
+ * Allowed elements in tables
1129
+ */
1130
+ table_allowed_elements?: string[];
1131
+ };
1132
+ /**
1133
+ * MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md034.md
1134
+ */
1135
+ MD034?: boolean | ('error' | 'warning') | {
1136
+ /**
1137
+ * Whether to enable the rule
1138
+ */
1139
+ enabled?: boolean;
1140
+ /**
1141
+ * Rule severity
1142
+ */
1143
+ severity?: 'error' | 'warning';
1144
+ };
1145
+ /**
1146
+ * MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md034.md
1147
+ */
1148
+ 'no-bare-urls'?: boolean | ('error' | 'warning') | {
1149
+ /**
1150
+ * Whether to enable the rule
1151
+ */
1152
+ enabled?: boolean;
1153
+ /**
1154
+ * Rule severity
1155
+ */
1156
+ severity?: 'error' | 'warning';
1157
+ };
1158
+ /**
1159
+ * MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md035.md
1160
+ */
1161
+ MD035?: boolean | ('error' | 'warning') | {
1162
+ /**
1163
+ * Whether to enable the rule
1164
+ */
1165
+ enabled?: boolean;
1166
+ /**
1167
+ * Rule severity
1168
+ */
1169
+ severity?: 'error' | 'warning';
1170
+ /**
1171
+ * Horizontal rule style
1172
+ */
1173
+ style?: string;
1174
+ };
1175
+ /**
1176
+ * MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md035.md
1177
+ */
1178
+ 'hr-style'?: boolean | ('error' | 'warning') | {
1179
+ /**
1180
+ * Whether to enable the rule
1181
+ */
1182
+ enabled?: boolean;
1183
+ /**
1184
+ * Rule severity
1185
+ */
1186
+ severity?: 'error' | 'warning';
1187
+ /**
1188
+ * Horizontal rule style
1189
+ */
1190
+ style?: string;
1191
+ };
1192
+ /**
1193
+ * MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md036.md
1194
+ */
1195
+ MD036?: boolean | ('error' | 'warning') | {
1196
+ /**
1197
+ * Whether to enable the rule
1198
+ */
1199
+ enabled?: boolean;
1200
+ /**
1201
+ * Rule severity
1202
+ */
1203
+ severity?: 'error' | 'warning';
1204
+ /**
1205
+ * Punctuation characters
1206
+ */
1207
+ punctuation?: string;
1208
+ };
1209
+ /**
1210
+ * MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md036.md
1211
+ */
1212
+ 'no-emphasis-as-heading'?: boolean | ('error' | 'warning') | {
1213
+ /**
1214
+ * Whether to enable the rule
1215
+ */
1216
+ enabled?: boolean;
1217
+ /**
1218
+ * Rule severity
1219
+ */
1220
+ severity?: 'error' | 'warning';
1221
+ /**
1222
+ * Punctuation characters
1223
+ */
1224
+ punctuation?: string;
1225
+ };
1226
+ /**
1227
+ * MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md037.md
1228
+ */
1229
+ MD037?: boolean | ('error' | 'warning') | {
1230
+ /**
1231
+ * Whether to enable the rule
1232
+ */
1233
+ enabled?: boolean;
1234
+ /**
1235
+ * Rule severity
1236
+ */
1237
+ severity?: 'error' | 'warning';
1238
+ };
1239
+ /**
1240
+ * MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md037.md
1241
+ */
1242
+ 'no-space-in-emphasis'?: boolean | ('error' | 'warning') | {
1243
+ /**
1244
+ * Whether to enable the rule
1245
+ */
1246
+ enabled?: boolean;
1247
+ /**
1248
+ * Rule severity
1249
+ */
1250
+ severity?: 'error' | 'warning';
1251
+ };
1252
+ /**
1253
+ * MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md038.md
1254
+ */
1255
+ MD038?: boolean | ('error' | 'warning') | {
1256
+ /**
1257
+ * Whether to enable the rule
1258
+ */
1259
+ enabled?: boolean;
1260
+ /**
1261
+ * Rule severity
1262
+ */
1263
+ severity?: 'error' | 'warning';
1264
+ };
1265
+ /**
1266
+ * MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md038.md
1267
+ */
1268
+ 'no-space-in-code'?: boolean | ('error' | 'warning') | {
1269
+ /**
1270
+ * Whether to enable the rule
1271
+ */
1272
+ enabled?: boolean;
1273
+ /**
1274
+ * Rule severity
1275
+ */
1276
+ severity?: 'error' | 'warning';
1277
+ };
1278
+ /**
1279
+ * MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md039.md
1280
+ */
1281
+ MD039?: boolean | ('error' | 'warning') | {
1282
+ /**
1283
+ * Whether to enable the rule
1284
+ */
1285
+ enabled?: boolean;
1286
+ /**
1287
+ * Rule severity
1288
+ */
1289
+ severity?: 'error' | 'warning';
1290
+ };
1291
+ /**
1292
+ * MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md039.md
1293
+ */
1294
+ 'no-space-in-links'?: boolean | ('error' | 'warning') | {
1295
+ /**
1296
+ * Whether to enable the rule
1297
+ */
1298
+ enabled?: boolean;
1299
+ /**
1300
+ * Rule severity
1301
+ */
1302
+ severity?: 'error' | 'warning';
1303
+ };
1304
+ /**
1305
+ * MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md040.md
1306
+ */
1307
+ MD040?: boolean | ('error' | 'warning') | {
1308
+ /**
1309
+ * Whether to enable the rule
1310
+ */
1311
+ enabled?: boolean;
1312
+ /**
1313
+ * Rule severity
1314
+ */
1315
+ severity?: 'error' | 'warning';
1316
+ /**
1317
+ * List of languages
1318
+ */
1319
+ allowed_languages?: string[];
1320
+ /**
1321
+ * Require language only
1322
+ */
1323
+ language_only?: boolean;
1324
+ };
1325
+ /**
1326
+ * MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md040.md
1327
+ */
1328
+ 'fenced-code-language'?: boolean | ('error' | 'warning') | {
1329
+ /**
1330
+ * Whether to enable the rule
1331
+ */
1332
+ enabled?: boolean;
1333
+ /**
1334
+ * Rule severity
1335
+ */
1336
+ severity?: 'error' | 'warning';
1337
+ /**
1338
+ * List of languages
1339
+ */
1340
+ allowed_languages?: string[];
1341
+ /**
1342
+ * Require language only
1343
+ */
1344
+ language_only?: boolean;
1345
+ };
1346
+ /**
1347
+ * MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md041.md
1348
+ */
1349
+ MD041?: boolean | ('error' | 'warning') | {
1350
+ /**
1351
+ * Whether to enable the rule
1352
+ */
1353
+ enabled?: boolean;
1354
+ /**
1355
+ * Rule severity
1356
+ */
1357
+ severity?: 'error' | 'warning';
1358
+ /**
1359
+ * Allow content before first heading
1360
+ */
1361
+ allow_preamble?: boolean;
1362
+ /**
1363
+ * RegExp for matching title in front matter
1364
+ */
1365
+ front_matter_title?: string;
1366
+ /**
1367
+ * Heading level
1368
+ */
1369
+ level?: number;
1370
+ };
1371
+ /**
1372
+ * MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md041.md
1373
+ */
1374
+ 'first-line-heading'?: boolean | ('error' | 'warning') | {
1375
+ /**
1376
+ * Whether to enable the rule
1377
+ */
1378
+ enabled?: boolean;
1379
+ /**
1380
+ * Rule severity
1381
+ */
1382
+ severity?: 'error' | 'warning';
1383
+ /**
1384
+ * Allow content before first heading
1385
+ */
1386
+ allow_preamble?: boolean;
1387
+ /**
1388
+ * RegExp for matching title in front matter
1389
+ */
1390
+ front_matter_title?: string;
1391
+ /**
1392
+ * Heading level
1393
+ */
1394
+ level?: number;
1395
+ };
1396
+ /**
1397
+ * MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md041.md
1398
+ */
1399
+ 'first-line-h1'?: boolean | ('error' | 'warning') | {
1400
+ /**
1401
+ * Whether to enable the rule
1402
+ */
1403
+ enabled?: boolean;
1404
+ /**
1405
+ * Rule severity
1406
+ */
1407
+ severity?: 'error' | 'warning';
1408
+ /**
1409
+ * Allow content before first heading
1410
+ */
1411
+ allow_preamble?: boolean;
1412
+ /**
1413
+ * RegExp for matching title in front matter
1414
+ */
1415
+ front_matter_title?: string;
1416
+ /**
1417
+ * Heading level
1418
+ */
1419
+ level?: number;
1420
+ };
1421
+ /**
1422
+ * MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md042.md
1423
+ */
1424
+ MD042?: boolean | ('error' | 'warning') | {
1425
+ /**
1426
+ * Whether to enable the rule
1427
+ */
1428
+ enabled?: boolean;
1429
+ /**
1430
+ * Rule severity
1431
+ */
1432
+ severity?: 'error' | 'warning';
1433
+ };
1434
+ /**
1435
+ * MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md042.md
1436
+ */
1437
+ 'no-empty-links'?: boolean | ('error' | 'warning') | {
1438
+ /**
1439
+ * Whether to enable the rule
1440
+ */
1441
+ enabled?: boolean;
1442
+ /**
1443
+ * Rule severity
1444
+ */
1445
+ severity?: 'error' | 'warning';
1446
+ };
1447
+ /**
1448
+ * MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md043.md
1449
+ */
1450
+ MD043?: boolean | ('error' | 'warning') | {
1451
+ /**
1452
+ * Whether to enable the rule
1453
+ */
1454
+ enabled?: boolean;
1455
+ /**
1456
+ * Rule severity
1457
+ */
1458
+ severity?: 'error' | 'warning';
1459
+ /**
1460
+ * List of headings
1461
+ */
1462
+ headings?: string[];
1463
+ /**
1464
+ * Match case of headings
1465
+ */
1466
+ match_case?: boolean;
1467
+ };
1468
+ /**
1469
+ * MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md043.md
1470
+ */
1471
+ 'required-headings'?: boolean | ('error' | 'warning') | {
1472
+ /**
1473
+ * Whether to enable the rule
1474
+ */
1475
+ enabled?: boolean;
1476
+ /**
1477
+ * Rule severity
1478
+ */
1479
+ severity?: 'error' | 'warning';
1480
+ /**
1481
+ * List of headings
1482
+ */
1483
+ headings?: string[];
1484
+ /**
1485
+ * Match case of headings
1486
+ */
1487
+ match_case?: boolean;
1488
+ };
1489
+ /**
1490
+ * MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md044.md
1491
+ */
1492
+ MD044?: boolean | ('error' | 'warning') | {
1493
+ /**
1494
+ * Whether to enable the rule
1495
+ */
1496
+ enabled?: boolean;
1497
+ /**
1498
+ * Rule severity
1499
+ */
1500
+ severity?: 'error' | 'warning';
1501
+ /**
1502
+ * List of proper names
1503
+ */
1504
+ names?: string[];
1505
+ /**
1506
+ * Include code blocks
1507
+ */
1508
+ code_blocks?: boolean;
1509
+ /**
1510
+ * Include HTML elements
1511
+ */
1512
+ html_elements?: boolean;
1513
+ };
1514
+ /**
1515
+ * MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md044.md
1516
+ */
1517
+ 'proper-names'?: boolean | ('error' | 'warning') | {
1518
+ /**
1519
+ * Whether to enable the rule
1520
+ */
1521
+ enabled?: boolean;
1522
+ /**
1523
+ * Rule severity
1524
+ */
1525
+ severity?: 'error' | 'warning';
1526
+ /**
1527
+ * List of proper names
1528
+ */
1529
+ names?: string[];
1530
+ /**
1531
+ * Include code blocks
1532
+ */
1533
+ code_blocks?: boolean;
1534
+ /**
1535
+ * Include HTML elements
1536
+ */
1537
+ html_elements?: boolean;
1538
+ };
1539
+ /**
1540
+ * MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md045.md
1541
+ */
1542
+ MD045?: boolean | ('error' | 'warning') | {
1543
+ /**
1544
+ * Whether to enable the rule
1545
+ */
1546
+ enabled?: boolean;
1547
+ /**
1548
+ * Rule severity
1549
+ */
1550
+ severity?: 'error' | 'warning';
1551
+ };
1552
+ /**
1553
+ * MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md045.md
1554
+ */
1555
+ 'no-alt-text'?: boolean | ('error' | 'warning') | {
1556
+ /**
1557
+ * Whether to enable the rule
1558
+ */
1559
+ enabled?: boolean;
1560
+ /**
1561
+ * Rule severity
1562
+ */
1563
+ severity?: 'error' | 'warning';
1564
+ };
1565
+ /**
1566
+ * MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md046.md
1567
+ */
1568
+ MD046?: boolean | ('error' | 'warning') | {
1569
+ /**
1570
+ * Whether to enable the rule
1571
+ */
1572
+ enabled?: boolean;
1573
+ /**
1574
+ * Rule severity
1575
+ */
1576
+ severity?: 'error' | 'warning';
1577
+ /**
1578
+ * Block style
1579
+ */
1580
+ style?: 'consistent' | 'fenced' | 'indented';
1581
+ };
1582
+ /**
1583
+ * MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md046.md
1584
+ */
1585
+ 'code-block-style'?: boolean | ('error' | 'warning') | {
1586
+ /**
1587
+ * Whether to enable the rule
1588
+ */
1589
+ enabled?: boolean;
1590
+ /**
1591
+ * Rule severity
1592
+ */
1593
+ severity?: 'error' | 'warning';
1594
+ /**
1595
+ * Block style
1596
+ */
1597
+ style?: 'consistent' | 'fenced' | 'indented';
1598
+ };
1599
+ /**
1600
+ * MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md047.md
1601
+ */
1602
+ MD047?: boolean | ('error' | 'warning') | {
1603
+ /**
1604
+ * Whether to enable the rule
1605
+ */
1606
+ enabled?: boolean;
1607
+ /**
1608
+ * Rule severity
1609
+ */
1610
+ severity?: 'error' | 'warning';
1611
+ };
1612
+ /**
1613
+ * MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md047.md
1614
+ */
1615
+ 'single-trailing-newline'?: boolean | ('error' | 'warning') | {
1616
+ /**
1617
+ * Whether to enable the rule
1618
+ */
1619
+ enabled?: boolean;
1620
+ /**
1621
+ * Rule severity
1622
+ */
1623
+ severity?: 'error' | 'warning';
1624
+ };
1625
+ /**
1626
+ * MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md048.md
1627
+ */
1628
+ MD048?: boolean | ('error' | 'warning') | {
1629
+ /**
1630
+ * Whether to enable the rule
1631
+ */
1632
+ enabled?: boolean;
1633
+ /**
1634
+ * Rule severity
1635
+ */
1636
+ severity?: 'error' | 'warning';
1637
+ /**
1638
+ * Code fence style
1639
+ */
1640
+ style?: 'consistent' | 'backtick' | 'tilde';
1641
+ };
1642
+ /**
1643
+ * MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md048.md
1644
+ */
1645
+ 'code-fence-style'?: boolean | ('error' | 'warning') | {
1646
+ /**
1647
+ * Whether to enable the rule
1648
+ */
1649
+ enabled?: boolean;
1650
+ /**
1651
+ * Rule severity
1652
+ */
1653
+ severity?: 'error' | 'warning';
1654
+ /**
1655
+ * Code fence style
1656
+ */
1657
+ style?: 'consistent' | 'backtick' | 'tilde';
1658
+ };
1659
+ /**
1660
+ * MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md049.md
1661
+ */
1662
+ MD049?: boolean | ('error' | 'warning') | {
1663
+ /**
1664
+ * Whether to enable the rule
1665
+ */
1666
+ enabled?: boolean;
1667
+ /**
1668
+ * Rule severity
1669
+ */
1670
+ severity?: 'error' | 'warning';
1671
+ /**
1672
+ * Emphasis style
1673
+ */
1674
+ style?: 'consistent' | 'asterisk' | 'underscore';
1675
+ };
1676
+ /**
1677
+ * MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md049.md
1678
+ */
1679
+ 'emphasis-style'?: boolean | ('error' | 'warning') | {
1680
+ /**
1681
+ * Whether to enable the rule
1682
+ */
1683
+ enabled?: boolean;
1684
+ /**
1685
+ * Rule severity
1686
+ */
1687
+ severity?: 'error' | 'warning';
1688
+ /**
1689
+ * Emphasis style
1690
+ */
1691
+ style?: 'consistent' | 'asterisk' | 'underscore';
1692
+ };
1693
+ /**
1694
+ * MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md050.md
1695
+ */
1696
+ MD050?: boolean | ('error' | 'warning') | {
1697
+ /**
1698
+ * Whether to enable the rule
1699
+ */
1700
+ enabled?: boolean;
1701
+ /**
1702
+ * Rule severity
1703
+ */
1704
+ severity?: 'error' | 'warning';
1705
+ /**
1706
+ * Strong style
1707
+ */
1708
+ style?: 'consistent' | 'asterisk' | 'underscore';
1709
+ };
1710
+ /**
1711
+ * MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md050.md
1712
+ */
1713
+ 'strong-style'?: boolean | ('error' | 'warning') | {
1714
+ /**
1715
+ * Whether to enable the rule
1716
+ */
1717
+ enabled?: boolean;
1718
+ /**
1719
+ * Rule severity
1720
+ */
1721
+ severity?: 'error' | 'warning';
1722
+ /**
1723
+ * Strong style
1724
+ */
1725
+ style?: 'consistent' | 'asterisk' | 'underscore';
1726
+ };
1727
+ /**
1728
+ * MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md051.md
1729
+ */
1730
+ MD051?: boolean | ('error' | 'warning') | {
1731
+ /**
1732
+ * Whether to enable the rule
1733
+ */
1734
+ enabled?: boolean;
1735
+ /**
1736
+ * Rule severity
1737
+ */
1738
+ severity?: 'error' | 'warning';
1739
+ /**
1740
+ * Ignore case of fragments
1741
+ */
1742
+ ignore_case?: boolean;
1743
+ /**
1744
+ * Pattern for ignoring additional fragments
1745
+ */
1746
+ ignored_pattern?: string;
1747
+ };
1748
+ /**
1749
+ * MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md051.md
1750
+ */
1751
+ 'link-fragments'?: boolean | ('error' | 'warning') | {
1752
+ /**
1753
+ * Whether to enable the rule
1754
+ */
1755
+ enabled?: boolean;
1756
+ /**
1757
+ * Rule severity
1758
+ */
1759
+ severity?: 'error' | 'warning';
1760
+ /**
1761
+ * Ignore case of fragments
1762
+ */
1763
+ ignore_case?: boolean;
1764
+ /**
1765
+ * Pattern for ignoring additional fragments
1766
+ */
1767
+ ignored_pattern?: string;
1768
+ };
1769
+ /**
1770
+ * MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md052.md
1771
+ */
1772
+ MD052?: boolean | ('error' | 'warning') | {
1773
+ /**
1774
+ * Whether to enable the rule
1775
+ */
1776
+ enabled?: boolean;
1777
+ /**
1778
+ * Rule severity
1779
+ */
1780
+ severity?: 'error' | 'warning';
1781
+ /**
1782
+ * Ignored link labels
1783
+ */
1784
+ ignored_labels?: string[];
1785
+ /**
1786
+ * Include shortcut syntax
1787
+ */
1788
+ shortcut_syntax?: boolean;
1789
+ };
1790
+ /**
1791
+ * MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md052.md
1792
+ */
1793
+ 'reference-links-images'?: boolean | ('error' | 'warning') | {
1794
+ /**
1795
+ * Whether to enable the rule
1796
+ */
1797
+ enabled?: boolean;
1798
+ /**
1799
+ * Rule severity
1800
+ */
1801
+ severity?: 'error' | 'warning';
1802
+ /**
1803
+ * Ignored link labels
1804
+ */
1805
+ ignored_labels?: string[];
1806
+ /**
1807
+ * Include shortcut syntax
1808
+ */
1809
+ shortcut_syntax?: boolean;
1810
+ };
1811
+ /**
1812
+ * MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md053.md
1813
+ */
1814
+ MD053?: boolean | ('error' | 'warning') | {
1815
+ /**
1816
+ * Whether to enable the rule
1817
+ */
1818
+ enabled?: boolean;
1819
+ /**
1820
+ * Rule severity
1821
+ */
1822
+ severity?: 'error' | 'warning';
1823
+ /**
1824
+ * Ignored definitions
1825
+ */
1826
+ ignored_definitions?: string[];
1827
+ };
1828
+ /**
1829
+ * MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md053.md
1830
+ */
1831
+ 'link-image-reference-definitions'?: boolean | ('error' | 'warning') | {
1832
+ /**
1833
+ * Whether to enable the rule
1834
+ */
1835
+ enabled?: boolean;
1836
+ /**
1837
+ * Rule severity
1838
+ */
1839
+ severity?: 'error' | 'warning';
1840
+ /**
1841
+ * Ignored definitions
1842
+ */
1843
+ ignored_definitions?: string[];
1844
+ };
1845
+ /**
1846
+ * MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md054.md
1847
+ */
1848
+ MD054?: boolean | ('error' | 'warning') | {
1849
+ /**
1850
+ * Whether to enable the rule
1851
+ */
1852
+ enabled?: boolean;
1853
+ /**
1854
+ * Rule severity
1855
+ */
1856
+ severity?: 'error' | 'warning';
1857
+ /**
1858
+ * Allow autolinks
1859
+ */
1860
+ autolink?: boolean;
1861
+ /**
1862
+ * Allow inline links and images
1863
+ */
1864
+ inline?: boolean;
1865
+ /**
1866
+ * Allow full reference links and images
1867
+ */
1868
+ full?: boolean;
1869
+ /**
1870
+ * Allow collapsed reference links and images
1871
+ */
1872
+ collapsed?: boolean;
1873
+ /**
1874
+ * Allow shortcut reference links and images
1875
+ */
1876
+ shortcut?: boolean;
1877
+ /**
1878
+ * Allow URLs as inline links
1879
+ */
1880
+ url_inline?: boolean;
1881
+ };
1882
+ /**
1883
+ * MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md054.md
1884
+ */
1885
+ 'link-image-style'?: boolean | ('error' | 'warning') | {
1886
+ /**
1887
+ * Whether to enable the rule
1888
+ */
1889
+ enabled?: boolean;
1890
+ /**
1891
+ * Rule severity
1892
+ */
1893
+ severity?: 'error' | 'warning';
1894
+ /**
1895
+ * Allow autolinks
1896
+ */
1897
+ autolink?: boolean;
1898
+ /**
1899
+ * Allow inline links and images
1900
+ */
1901
+ inline?: boolean;
1902
+ /**
1903
+ * Allow full reference links and images
1904
+ */
1905
+ full?: boolean;
1906
+ /**
1907
+ * Allow collapsed reference links and images
1908
+ */
1909
+ collapsed?: boolean;
1910
+ /**
1911
+ * Allow shortcut reference links and images
1912
+ */
1913
+ shortcut?: boolean;
1914
+ /**
1915
+ * Allow URLs as inline links
1916
+ */
1917
+ url_inline?: boolean;
1918
+ };
1919
+ /**
1920
+ * MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md055.md
1921
+ */
1922
+ MD055?: boolean | ('error' | 'warning') | {
1923
+ /**
1924
+ * Whether to enable the rule
1925
+ */
1926
+ enabled?: boolean;
1927
+ /**
1928
+ * Rule severity
1929
+ */
1930
+ severity?: 'error' | 'warning';
1931
+ /**
1932
+ * Table pipe style
1933
+ */
1934
+ style?: 'consistent' | 'leading_only' | 'trailing_only' | 'leading_and_trailing' | 'no_leading_or_trailing';
1935
+ };
1936
+ /**
1937
+ * MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md055.md
1938
+ */
1939
+ 'table-pipe-style'?: boolean | ('error' | 'warning') | {
1940
+ /**
1941
+ * Whether to enable the rule
1942
+ */
1943
+ enabled?: boolean;
1944
+ /**
1945
+ * Rule severity
1946
+ */
1947
+ severity?: 'error' | 'warning';
1948
+ /**
1949
+ * Table pipe style
1950
+ */
1951
+ style?: 'consistent' | 'leading_only' | 'trailing_only' | 'leading_and_trailing' | 'no_leading_or_trailing';
1952
+ };
1953
+ /**
1954
+ * MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md056.md
1955
+ */
1956
+ MD056?: boolean | ('error' | 'warning') | {
1957
+ /**
1958
+ * Whether to enable the rule
1959
+ */
1960
+ enabled?: boolean;
1961
+ /**
1962
+ * Rule severity
1963
+ */
1964
+ severity?: 'error' | 'warning';
1965
+ };
1966
+ /**
1967
+ * MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md056.md
1968
+ */
1969
+ 'table-column-count'?: boolean | ('error' | 'warning') | {
1970
+ /**
1971
+ * Whether to enable the rule
1972
+ */
1973
+ enabled?: boolean;
1974
+ /**
1975
+ * Rule severity
1976
+ */
1977
+ severity?: 'error' | 'warning';
1978
+ };
1979
+ /**
1980
+ * MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md058.md
1981
+ */
1982
+ MD058?: boolean | ('error' | 'warning') | {
1983
+ /**
1984
+ * Whether to enable the rule
1985
+ */
1986
+ enabled?: boolean;
1987
+ /**
1988
+ * Rule severity
1989
+ */
1990
+ severity?: 'error' | 'warning';
1991
+ };
1992
+ /**
1993
+ * MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md058.md
1994
+ */
1995
+ 'blanks-around-tables'?: boolean | ('error' | 'warning') | {
1996
+ /**
1997
+ * Whether to enable the rule
1998
+ */
1999
+ enabled?: boolean;
2000
+ /**
2001
+ * Rule severity
2002
+ */
2003
+ severity?: 'error' | 'warning';
2004
+ };
2005
+ /**
2006
+ * MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md059.md
2007
+ */
2008
+ MD059?: boolean | ('error' | 'warning') | {
2009
+ /**
2010
+ * Whether to enable the rule
2011
+ */
2012
+ enabled?: boolean;
2013
+ /**
2014
+ * Rule severity
2015
+ */
2016
+ severity?: 'error' | 'warning';
2017
+ /**
2018
+ * Prohibited link texts
2019
+ */
2020
+ prohibited_texts?: string[];
2021
+ };
2022
+ /**
2023
+ * MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md059.md
2024
+ */
2025
+ 'descriptive-link-text'?: boolean | ('error' | 'warning') | {
2026
+ /**
2027
+ * Whether to enable the rule
2028
+ */
2029
+ enabled?: boolean;
2030
+ /**
2031
+ * Rule severity
2032
+ */
2033
+ severity?: 'error' | 'warning';
2034
+ /**
2035
+ * Prohibited link texts
2036
+ */
2037
+ prohibited_texts?: string[];
2038
+ };
2039
+ /**
2040
+ * MD060/table-column-style : Table column style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md060.md
2041
+ */
2042
+ MD060?: boolean | ('error' | 'warning') | {
2043
+ /**
2044
+ * Whether to enable the rule
2045
+ */
2046
+ enabled?: boolean;
2047
+ /**
2048
+ * Rule severity
2049
+ */
2050
+ severity?: 'error' | 'warning';
2051
+ /**
2052
+ * Table column style
2053
+ */
2054
+ style?: 'any' | 'aligned' | 'compact' | 'tight';
2055
+ /**
2056
+ * Aligned delimiter columns
2057
+ */
2058
+ aligned_delimiter?: boolean;
2059
+ };
2060
+ /**
2061
+ * MD060/table-column-style : Table column style : https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md060.md
2062
+ */
2063
+ 'table-column-style'?: boolean | ('error' | 'warning') | {
2064
+ /**
2065
+ * Whether to enable the rule
2066
+ */
2067
+ enabled?: boolean;
2068
+ /**
2069
+ * Rule severity
2070
+ */
2071
+ severity?: 'error' | 'warning';
2072
+ /**
2073
+ * Table column style
2074
+ */
2075
+ style?: 'any' | 'aligned' | 'compact' | 'tight';
2076
+ /**
2077
+ * Aligned delimiter columns
2078
+ */
2079
+ aligned_delimiter?: boolean;
2080
+ };
2081
+ /**
2082
+ * headings : MD001, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043
2083
+ */
2084
+ headings?: boolean | ('error' | 'warning');
2085
+ /**
2086
+ * bullet : MD004, MD005, MD007, MD032
2087
+ */
2088
+ bullet?: boolean | ('error' | 'warning');
2089
+ /**
2090
+ * ul : MD004, MD005, MD007, MD030, MD032
2091
+ */
2092
+ ul?: boolean | ('error' | 'warning');
2093
+ /**
2094
+ * indentation : MD005, MD007, MD027
2095
+ */
2096
+ indentation?: boolean | ('error' | 'warning');
2097
+ /**
2098
+ * whitespace : MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039
2099
+ */
2100
+ whitespace?: boolean | ('error' | 'warning');
2101
+ /**
2102
+ * hard_tab : MD010
2103
+ */
2104
+ hard_tab?: boolean | ('error' | 'warning');
2105
+ /**
2106
+ * links : MD011, MD034, MD039, MD042, MD051, MD052, MD053, MD054, MD059
2107
+ */
2108
+ links?: boolean | ('error' | 'warning');
2109
+ /**
2110
+ * blank_lines : MD012, MD022, MD031, MD032, MD047
2111
+ */
2112
+ blank_lines?: boolean | ('error' | 'warning');
2113
+ /**
2114
+ * line_length : MD013
2115
+ */
2116
+ line_length?: boolean | ('error' | 'warning');
2117
+ /**
2118
+ * code : MD014, MD031, MD038, MD040, MD046, MD048
2119
+ */
2120
+ code?: boolean | ('error' | 'warning');
2121
+ /**
2122
+ * atx : MD018, MD019
2123
+ */
2124
+ atx?: boolean | ('error' | 'warning');
2125
+ /**
2126
+ * spaces : MD018, MD019, MD020, MD021, MD023
2127
+ */
2128
+ spaces?: boolean | ('error' | 'warning');
2129
+ /**
2130
+ * atx_closed : MD020, MD021
2131
+ */
2132
+ atx_closed?: boolean | ('error' | 'warning');
2133
+ /**
2134
+ * blockquote : MD027, MD028
2135
+ */
2136
+ blockquote?: boolean | ('error' | 'warning');
2137
+ /**
2138
+ * ol : MD029, MD030, MD032
2139
+ */
2140
+ ol?: boolean | ('error' | 'warning');
2141
+ /**
2142
+ * html : MD033
2143
+ */
2144
+ html?: boolean | ('error' | 'warning');
2145
+ /**
2146
+ * url : MD034
2147
+ */
2148
+ url?: boolean | ('error' | 'warning');
2149
+ /**
2150
+ * hr : MD035
2151
+ */
2152
+ hr?: boolean | ('error' | 'warning');
2153
+ /**
2154
+ * emphasis : MD036, MD037, MD049, MD050
2155
+ */
2156
+ emphasis?: boolean | ('error' | 'warning');
2157
+ /**
2158
+ * language : MD040
2159
+ */
2160
+ language?: boolean | ('error' | 'warning');
2161
+ /**
2162
+ * spelling : MD044
2163
+ */
2164
+ spelling?: boolean | ('error' | 'warning');
2165
+ /**
2166
+ * accessibility : MD045, MD059
2167
+ */
2168
+ accessibility?: boolean | ('error' | 'warning');
2169
+ /**
2170
+ * images : MD045, MD052, MD053, MD054
2171
+ */
2172
+ images?: boolean | ('error' | 'warning');
2173
+ /**
2174
+ * table : MD055, MD056, MD058, MD060
2175
+ */
2176
+ table?: boolean | ('error' | 'warning');
2177
+ }
2178
+ //#endregion
2179
+ //#region ../src/js/markdownlint/types/rules.d.ts
2180
+ type TableStyle = 'aligned' | 'compact' | 'tight' | 'any';
2181
+ type SearchScope = 'all' | 'code' | 'text';
2182
+ interface SearchReplaceRule {
2183
+ name: string;
2184
+ message: string;
2185
+ information?: string;
2186
+ search?: string | string[];
2187
+ searchPattern?: string | string[];
2188
+ replace?: string | null | (string | null)[];
2189
+ searchScope?: SearchScope;
2190
+ }
2191
+ interface CustomRules {
2192
+ 'fenced-code-fence-length': boolean | FencedCodeFenceLengthConfig;
2193
+ 'heading-sentence-case': boolean | HeadingSentenceCaseConfig;
2194
+ 'list-item-marker-space': boolean | ListItemMarkerSpaceConfig;
2195
+ 'no-default-alt-text': boolean;
2196
+ 'no-empty-alt-text': boolean;
2197
+ 'no-generic-link-text': boolean;
2198
+ 'no-trailing-slash-in-links': boolean;
2199
+ 'reference-link-section-placement': boolean;
2200
+ 'relative-links': boolean | Partial<Record<'root_path' | 'fragment-index-divider', string>>;
2201
+ 'search-replace': boolean | {
2202
+ rules: SearchReplaceRule[];
2203
+ };
2204
+ 'setext-heading-blank-lines': boolean | SetextHeadingBlankLinesConfig;
2205
+ 'table-format': boolean | Partial<Record<'style', TableStyle> & Record<'aligned_delimiter' | 'fix' | 'fixApplicator', boolean>>;
2206
+ }
2207
+ //#endregion
2208
+ //#region ../src/js/markdownlint/types/config.d.ts
2209
+ type Rules = Rules$1 & Partial<CustomRules>;
2210
+ type Override = Omit<NonNullable<Config$1['overrides']>[number], 'config'> & {
2211
+ config: Rules;
2212
+ };
2213
+ type Config = Omit<Config$1, 'config' | 'overrides'> & {
2214
+ config?: Rules;
2215
+ overrides?: Override[];
2216
+ };
2217
+ //#endregion
2218
+ //#region ../src/js/markdownlint/types/options.d.ts
2219
+ interface ConfigOptions {
2220
+ /**
2221
+ * Enables `@github/markdownlint-github`.
2222
+ *
2223
+ * @default `Enabled when "@github/markdownlint-github" is installed.`
2224
+ *
2225
+ * @see https://github.com/github/markdownlint-github
2226
+ */
2227
+ github: boolean;
2228
+ /**
2229
+ * Enables `markdownlint-rule-relative-links` and `markdownlint-rule-no-trailing-slash-in-links`.
2230
+ *
2231
+ * @default `Enabled when "markdownlint-rule-relative-links" or "markdownlint-rule-no-trailing-slash-in-links" is installed.`
2232
+ *
2233
+ * @see https://github.com/theoludwig/markdownlint-rule-relative-links
2234
+ * @see https://github.com/xiaogaozi/markdownlint-rule-no-trailing-slash-in-links
2235
+ */
2236
+ links: boolean;
2237
+ /**
2238
+ * Enables `markdownlint-rule-search-replace`.
2239
+ *
2240
+ * @default `Enabled when "markdownlint-rule-search-replace" is installed.`
2241
+ *
2242
+ * @see https://github.com/OnkarRuikar/markdownlint-rule-search-replace
2243
+ */
2244
+ search: boolean;
2245
+ /**
2246
+ * Enables `@hongminhee/markdownlint-rules`.
2247
+ *
2248
+ * @default `Enabled when "@hongminhee/markdownlint-rules" is installed.`
2249
+ *
2250
+ * @see https://github.com/dahlia/markdownlint-rules
2251
+ */
2252
+ style: boolean;
2253
+ /**
2254
+ * Enables `markdownlint-rule-table-format`.
2255
+ *
2256
+ * @default `Enabled when "markdownlint-rule-table-format" is installed.`
2257
+ *
2258
+ * @see https://github.com/swirle13/markdownlint-rule-table-format
2259
+ */
2260
+ tables: boolean;
2261
+ }
2262
+ type UserOptions = Partial<ConfigOptions> & Config;
2263
+ //#endregion
2264
+ //#region ../src/js/markdownlint/index.d.ts
2265
+ /**
2266
+ * Build the `@brnshkr` markdownlint config object.
2267
+ *
2268
+ * The result is the shape `markdownlint-cli2` reads rather than the plain rule set, because `ignores` and
2269
+ * `globs` exist only at that level — which is why a consumer needs a config file of its own instead of
2270
+ * extending a shared rule set.
2271
+ *
2272
+ * @api
2273
+ *
2274
+ * @param optionsAndGlobalConfig per-module toggles and global markdownlint-cli2 fields merged with the defaults
2275
+ * @param additionalConfigs extra config entries merged after the built-in ones
2276
+ *
2277
+ * @returns final config ready to be consumed by markdownlint-cli2
2278
+ *
2279
+ * @see https://github.com/brnshkr/config/blob/master/docs/js/markdownlint.md
2280
+ *
2281
+ * @example
2282
+ * ```js
2283
+ * import { getConfig } from '@brnshkr/config/markdownlint';
2284
+ *
2285
+ * getConfig(undefined);
2286
+ * getConfig({});
2287
+ *
2288
+ * getConfig({
2289
+ * links: false,
2290
+ * ignores: ['CHANGELOG.md'],
2291
+ * }, {
2292
+ * config: { 'no-bare-urls': false },
2293
+ * });
2294
+ * ```
2295
+ */
2296
+ export declare const getConfig: (optionsAndGlobalConfig?: UserOptions, ...additionalConfigs: Config[]) => Config;
2297
+ /**
2298
+ * Default-exported pre-built config for direct re-export from a Markdownlint config file.
2299
+ *
2300
+ * @api
2301
+ */
2302
+ declare const _default: Config;
2303
+ //#endregion
2304
+ export { _default as default };