Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-17 06:20:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Generate example JSONC configuration with all properties set to their default value.

Browse source
This commit is contained in:
David Anson 2021-01-19 20:41:04 -08:00
parent cc61de8f2b
commit 5b7e9b87be
8 changed files with 326 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

37
schema/build-config-example.js Normal file
View file

@ -0,0 +1,37 @@
// @ts-check
"use strict";
const fs = require("fs");
const path = require("path");
const configSchema = require("./markdownlint-config-schema.json");
const configExample = {};
for (const rule in configSchema.properties) {
if (/^(MD\d{3}|default|extends)$/.test(rule)) {
const properties = configSchema.properties[rule];
configExample[rule + "-description"] = properties.description;
configExample[rule] = properties.default;
if (properties.properties) {
const ruleExample = {};
// eslint-disable-next-line guard-for-in
for (const property in properties.properties) {
const ruleProperties = properties.properties[property];
ruleExample[property + "-sub-description"] = ruleProperties.description;
ruleExample[property] = ruleProperties.default;
}
configExample[rule] = ruleExample;
}
}
}
const configString = JSON.stringify(configExample, null, 2)
// eslint-disable-next-line max-len
.replace(/^\{/, "{\n // Example markdownlint JSON(C) configuration with all properties set to their default value")
.replace(/(\s+)"[^-"]+-description": "(.+)",/g, "\n$1// $2")
.replace(/"[^-"]+-sub-description": "(.+)",/g, "// $1");
fs.writeFileSync(
path.join(__dirname, ".markdownlint.jsonc"),
configString,
"utf8"
);