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

Allow unknown (custom) rule names in .markdownlint.json schema.

Browse source
This commit is contained in:
David Anson 2020-09-15 21:48:00 -07:00
parent 3f637ba8e5
commit 6061cce169
3 changed files with 44 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
schema/build-config-schema.js
View file

@ -28,7 +28,12 @@ const schema = {
"/main/schema/markdownlint-config-schema.json" "/main/schema/markdownlint-config-schema.json"
} }
}, },
"additionalProperties": false "additionalProperties": {
"type:": [
"boolean",
"object"
]
}
}; };
const tags = {}; const tags = {};

7
schema/markdownlint-config-schema.json
View file

@ -1547,5 +1547,10 @@
"default": true "default": true
} }
}, },
"additionalProperties": false "additionalProperties": {
"type:": [
"boolean",
"object"
]
}
} }

34
test/markdownlint-test.js
View file

@ -22,6 +22,10 @@ const homepage = packageJson.homepage;
const version = packageJson.version; const version = packageJson.version;
const deprecatedRuleNames = new Set([ "MD002", "MD006" ]); const deprecatedRuleNames = new Set([ "MD002", "MD006" ]);
const configSchemaStrict = {
...configSchema,
"additionalProperties": false
};
tape("simpleAsync", (test) => { tape("simpleAsync", (test) => {
test.plan(2); test.plan(2);
@ -940,7 +944,7 @@ tape("rules", (test) => {
}); });
}); });
tape("validateConfigSchema", (test) => { tape("validateJsonUsingConfigSchemaStrict", (test) => {
const jsonFileRe = /\.json$/i; const jsonFileRe = /\.json$/i;
const resultsFileRe = /\.results\.json$/i; const resultsFileRe = /\.results\.json$/i;
const jsConfigFileRe = /^jsconfig\.json$/i; const jsConfigFileRe = /^jsconfig\.json$/i;
@ -958,12 +962,38 @@ tape("validateConfigSchema", (test) => {
"utf8" "utf8"
); );
test.ok( test.ok(
tv4.validate(JSON.parse(data), configSchema), // @ts-ignore
tv4.validate(JSON.parse(data), configSchemaStrict),
file + "\n" + JSON.stringify(tv4.error, null, 2)); file + "\n" + JSON.stringify(tv4.error, null, 2));
}); });
test.end(); test.end();
}); });
tape("validateConfigSchemaAllowsUnknownProperties", (test) => {
test.plan(4);
const testCases = [
{
"property": true
},
{
"property": {
"object": 1
}
}
];
testCases.forEach((testCase) => {
test.ok(
// @ts-ignore
tv4.validate(testCase, configSchema),
"Unknown property blocked by default: " + JSON.stringify(testCase));
test.notok(
// @ts-ignore
tv4.validate(testCase, configSchemaStrict),
"Unknown property allowed when strict: " + JSON.stringify(testCase));
});
test.end();
});
tape("configSingle", (test) => { tape("configSingle", (test) => {
test.plan(2); test.plan(2);
markdownlint.readConfig("./test/config/config-child.json", markdownlint.readConfig("./test/config/config-child.json",