-
-
Notifications
You must be signed in to change notification settings - Fork 753
/
Copy pathbuild-config-schema.js
579 lines (572 loc) · 14.2 KB
/
build-config-schema.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
// @ts-check
"use strict";
const fs = require("node:fs");
const path = require("node:path");
/** @type {import("../lib/markdownlint").Rule[]} */
const rules = require("../lib/rules");
const jsonSchemaToTypeScript = require("json-schema-to-typescript");
// Schema scaffolding
const schema = {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "markdownlint configuration schema",
"type": "object",
"properties": {
"default": {
"description": "Default state for all rules",
"type": "boolean",
"default": true
},
"extends": {
"description": "Path to configuration file to extend",
"type": [
"string",
"null"
],
"default": null
},
"$schema": {
"description": "JSON Schema URI (used by some editors)",
"type": "string",
"default": "https://raw.githubusercontent.com/DavidAnson/markdownlint" +
"/main/schema/markdownlint-config-schema.json"
}
},
"additionalProperties": {
"type": [
"boolean",
"object"
]
}
};
const tags = {};
// Add rules
for (const rule of rules) {
for (const tag of rule.tags) {
const tagRules = tags[tag] || [];
tagRules.push(rule.names[0]);
tags[tag] = tagRules;
}
const scheme = {
"description":
`${rule.names.join("/")} : ${rule.description} : ${rule.information}`,
"type": "boolean",
"default": true
};
let custom = true;
switch (rule.names[0]) {
case "MD003":
scheme.properties = {
"style": {
"description": "Heading style",
"type": "string",
"enum": [
"consistent",
"atx",
"atx_closed",
"setext",
"setext_with_atx",
"setext_with_atx_closed"
],
"default": "consistent"
}
};
break;
case "MD004":
scheme.properties = {
"style": {
"description": "List style",
"type": "string",
"enum": [
"consistent",
"asterisk",
"plus",
"dash",
"sublist"
],
"default": "consistent"
}
};
break;
case "MD007":
scheme.properties = {
"indent": {
"description": "Spaces for indent",
"type": "integer",
"minimum": 1,
"default": 2
},
"start_indented": {
"description": "Whether to indent the first level of the list",
"type": "boolean",
"default": false
},
"start_indent": {
"description":
"Spaces for first level indent (when start_indented is set)",
"type": "integer",
"minimum": 1,
"default": 2
}
};
break;
case "MD009":
scheme.properties = {
"br_spaces": {
"description": "Spaces for line break",
"type": "integer",
"minimum": 0,
"default": 2
},
"list_item_empty_lines": {
"description": "Allow spaces for empty lines in list items",
"type": "boolean",
"default": false
},
"strict": {
"description": "Include unnecessary breaks",
"type": "boolean",
"default": false
}
};
break;
case "MD010":
scheme.properties = {
"code_blocks": {
"description": "Include code blocks",
"type": "boolean",
"default": true
},
"ignore_code_languages": {
"description": "Fenced code languages to ignore",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"spaces_per_tab": {
"description": "Number of spaces for each hard tab",
"type": "integer",
"minimum": 0,
"default": 1
}
};
break;
case "MD012":
scheme.properties = {
"maximum": {
"description": "Consecutive blank lines",
"type": "integer",
"minimum": 1,
"default": 1
}
};
break;
case "MD013":
scheme.properties = {
"line_length": {
"description": "Number of characters",
"type": "integer",
"minimum": 1,
"default": 80
},
"heading_line_length": {
"description": "Number of characters for headings",
"type": "integer",
"minimum": 1,
"default": 80
},
"code_block_line_length": {
"description": "Number of characters for code blocks",
"type": "integer",
"minimum": 1,
"default": 80
},
"code_blocks": {
"description": "Include code blocks",
"type": "boolean",
"default": true
},
"tables": {
"description": "Include tables",
"type": "boolean",
"default": true
},
"headings": {
"description": "Include headings",
"type": "boolean",
"default": true
},
"strict": {
"description": "Strict length checking",
"type": "boolean",
"default": false
},
"stern": {
"description": "Stern length checking",
"type": "boolean",
"default": false
}
};
break;
case "MD022":
scheme.properties = {
"lines_above": {
"description": "Blank lines above heading",
"type": [
"integer",
"array"
],
"items": {
"type": "integer"
},
"minimum": -1,
"default": 1
},
"lines_below": {
"description": "Blank lines below heading",
"type": [
"integer",
"array"
],
"items": {
"type": "integer"
},
"minimum": -1,
"default": 1
}
};
break;
case "MD024":
scheme.properties = {
"allow_different_nesting": {
"description": "Only check sibling headings",
"type": "boolean",
"default": false
},
"siblings_only": {
"description": "Only check sibling headings",
"type": "boolean",
"default": false
}
};
break;
case "MD026":
scheme.properties = {
"punctuation": {
"description": "Punctuation characters",
"type": "string",
"default": ".,;:!。，；：！"
}
};
break;
case "MD036":
scheme.properties = {
"punctuation": {
"description": "Punctuation characters",
"type": "string",
"default": ".,;:!?。，；：！？"
}
};
break;
case "MD029":
scheme.properties = {
"style": {
"description": "List style",
"type": "string",
"enum": [
"one",
"ordered",
"one_or_ordered",
"zero"
],
"default": "one_or_ordered"
}
};
break;
case "MD030":
scheme.properties = {
"ul_single": {
"description": "Spaces for single-line unordered list items",
"type": "integer",
"minimum": 1,
"default": 1
},
"ol_single": {
"description": "Spaces for single-line ordered list items",
"type": "integer",
"minimum": 1,
"default": 1
},
"ul_multi": {
"description": "Spaces for multi-line unordered list items",
"type": "integer",
"minimum": 1,
"default": 1
},
"ol_multi": {
"description": "Spaces for multi-line ordered list items",
"type": "integer",
"minimum": 1,
"default": 1
}
};
break;
case "MD031":
scheme.properties = {
"list_items": {
"description": "Include list items",
"type": "boolean",
"default": true
}
};
break;
case "MD033":
scheme.properties = {
"allowed_elements": {
"description": "Allowed elements",
"type": "array",
"items": {
"type": "string"
},
"default": []
}
};
break;
case "MD035":
scheme.properties = {
"style": {
"description": "Horizontal rule style",
"type": "string",
"default": "consistent"
}
};
break;
case "MD040":
scheme.properties = {
"allowed_languages": {
"description": "List of languages",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"language_only": {
"description": "Require language only",
"type": "boolean",
"default": false
}
};
break;
case "MD025":
case "MD041":
scheme.properties = {
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
};
break;
case "MD043":
scheme.properties = {
"headings": {
"description": "List of headings",
"type": "array",
"items": {
"type": "string",
"pattern": "^(\\*|\\+|#{1,6} .*)$"
},
"default": []
},
"match_case": {
"description": "Match case of headings",
"type": "boolean",
"default": false
}
};
break;
case "MD044":
scheme.properties = {
"names": {
"description": "List of proper names",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"code_blocks": {
"description": "Include code blocks",
"type": "boolean",
"default": true
},
"html_elements": {
"description": "Include HTML elements",
"type": "boolean",
"default": true
}
};
break;
case "MD046":
scheme.properties = {
"style": {
"description": "Block style",
"type": "string",
"enum": [
"consistent",
"fenced",
"indented"
],
"default": "consistent"
}
};
break;
case "MD048":
scheme.properties = {
"style": {
"description": "Code fence style",
"type": "string",
"enum": [
"consistent",
"backtick",
"tilde"
],
"default": "consistent"
}
};
break;
case "MD049":
scheme.properties = {
"style": {
"description": "Emphasis style",
"type": "string",
"enum": [
"consistent",
"asterisk",
"underscore"
],
"default": "consistent"
}
};
break;
case "MD050":
scheme.properties = {
"style": {
"description": "Strong style",
"type": "string",
"enum": [
"consistent",
"asterisk",
"underscore"
],
"default": "consistent"
}
};
break;
case "MD052":
scheme.properties = {
"shortcut_syntax": {
"description": "Include shortcut syntax",
"type": "boolean",
"default": false
}
};
break;
case "MD053":
scheme.properties = {
"ignored_definitions": {
"description": "Ignored definitions",
"type": "array",
"items": {
"type": "string"
},
"default": [ "//" ]
}
};
break;
case "MD054":
scheme.properties = {
"autolink": {
"description": "Allow autolinks",
"type": "boolean",
"default": true
},
"inline": {
"description": "Allow inline links and images",
"type": "boolean",
"default": true
},
"full": {
"description": "Allow full reference links and images",
"type": "boolean",
"default": true
},
"collapsed": {
"description": "Allow collapsed reference links and images",
"type": "boolean",
"default": true
},
"shortcut": {
"description": "Allow shortcut reference links and images",
"type": "boolean",
"default": true
},
"url_inline": {
"description": "Allow URLs as inline links",
"type": "boolean",
"default": true
},
};
break;
default:
custom = false;
break;
}
if (custom) {
// @ts-ignore
scheme.type = [ "boolean", "object" ];
scheme.additionalProperties = false;
}
for (const name of rule.names) {
schema.properties[name] = scheme;
// Using $ref causes rule aliases not to get JSDoc comments
// schema.properties[name] = (index === 0) ? scheme : {
// "$ref": `#/properties/${rule.names[0]}`
// };
}
}
// Add tags
for (const [ tag, tagTags ] of Object.entries(tags)) {
const scheme = {
"description": `${tag} : ${tagTags.join(", ")}`,
"type": "boolean",
"default": true
};
schema.properties[tag] = scheme;
}
// Write schema
const schemaFile = path.join(__dirname, "markdownlint-config-schema.json");
fs.writeFileSync(schemaFile, JSON.stringify(schema, null, " "));
// Write TypeScript declaration
// See https://github.com/bcherny/json-schema-to-typescript/issues/356 for why
// additionalProperties is deleted
const schemaDeclaration =
path.join(__dirname, "..", "lib", "configuration.d.ts");
// @ts-ignore
delete schema.additionalProperties;
schema.title = "Configuration";
jsonSchemaToTypeScript.compile(
// @ts-ignore
schema,
"UNUSED"
// eslint-disable-next-line unicorn/prefer-top-level-await
).then((declaration) => fs.writeFileSync(schemaDeclaration, declaration));