Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-22 05:40:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Stop sharing params object across rules because doing so is unstable for asynchronous rules (fixes #510).

Browse source
This commit is contained in:
David Anson 2022-03-20 12:59:35 -07:00
parent 4affefc68d
commit 62f5c85238
3 changed files with 87 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

20
demo/markdownlint-browser.js
View file

@ -1498,22 +1498,22 @@ function lintContent(ruleList, name, content, md, config, frontMatter, handleRul
var aliasToRuleNames = mapAliasToRuleNames(ruleList);
var _a = getEnabledRulesPerLineNumber(ruleList, lines, frontMatterLines, noInlineConfig, config, aliasToRuleNames), effectiveConfig = _a.effectiveConfig, enabledRulesPerLineNumber = _a.enabledRulesPerLineNumber;
// Create parameters for rules
var params = {
"name": helpers.deepFreeze(name),
"tokens": helpers.deepFreeze(tokens),
"lines": helpers.deepFreeze(lines),
"frontMatterLines": helpers.deepFreeze(frontMatterLines)
};
cache.lineMetadata(helpers.getLineMetadata(params));
cache.flattenedLists(helpers.flattenLists(params.tokens));
cache.codeBlockAndSpanRanges(helpers.codeBlockAndSpanRanges(params, cache.lineMetadata()));
var paramsBase = helpers.deepFreeze({
name: name,
tokens: tokens,
lines: lines,
frontMatterLines: frontMatterLines
});
cache.lineMetadata(helpers.getLineMetadata(paramsBase));
cache.flattenedLists(helpers.flattenLists(paramsBase.tokens));
cache.codeBlockAndSpanRanges(helpers.codeBlockAndSpanRanges(paramsBase, cache.lineMetadata()));
// Function to run for each rule
var results = [];
// eslint-disable-next-line jsdoc/require-jsdoc
function forRule(rule) {
// Configure rule
var ruleName = rule.names[0].toUpperCase();
params.config = effectiveConfig[ruleName];
var params = __assign(__assign({}, paramsBase), { "config": effectiveConfig[ruleName] });
// eslint-disable-next-line jsdoc/require-jsdoc
function throwError(property) {
throw new Error("Property '" + property + "' of onError parameter is incorrect.");

23
lib/markdownlint.js
View file

@ -489,16 +489,16 @@ function lintContent(
aliasToRuleNames
);
// Create parameters for rules
const params = {
"name": helpers.deepFreeze(name),
"tokens": helpers.deepFreeze(tokens),
"lines": helpers.deepFreeze(lines),
"frontMatterLines": helpers.deepFreeze(frontMatterLines)
};
cache.lineMetadata(helpers.getLineMetadata(params));
cache.flattenedLists(helpers.flattenLists(params.tokens));
const paramsBase = helpers.deepFreeze({
name,
tokens,
lines,
frontMatterLines
});
cache.lineMetadata(helpers.getLineMetadata(paramsBase));
cache.flattenedLists(helpers.flattenLists(paramsBase.tokens));
cache.codeBlockAndSpanRanges(
helpers.codeBlockAndSpanRanges(params, cache.lineMetadata())
helpers.codeBlockAndSpanRanges(paramsBase, cache.lineMetadata())
);
// Function to run for each rule
let results = [];
@ -506,7 +506,10 @@ function lintContent(
function forRule(rule) {
// Configure rule
const ruleName = rule.names[0].toUpperCase();
params.config = effectiveConfig[ruleName];
const params = {
...paramsBase,
"config": effectiveConfig[ruleName]
};
// eslint-disable-next-line jsdoc/require-jsdoc
function throwError(property) {
throw new Error(

64
test/markdownlint-test-custom-rules.js
View file

@ -1195,6 +1195,70 @@ test("customRulesAsyncThrowsInSyncContext", (t) => {
);
});
test("customRulesParamsAreStable", (t) => {
t.plan(4);
const config1 = { "value1": 10 };
const config2 = { "value2": 20 };
const options = {
"config": {
"MD010": true,
"name1": config1,
"MD013": { "line_length": 200 },
"name2": config2,
"MD033": false
},
"customRules": [
{
"names": [ "name1" ],
"description": "description1",
"tags": [ "tag" ],
"asynchronous": true,
"function":
(params) => {
t.deepEqual(
params.config,
config1,
`Unexpected config in sync path: ${params.config}.`
);
return Promise.resolve().then(() => {
t.deepEqual(
params.config,
config1,
`Unexpected config in async path: ${params.config}.`
);
});
}
},
{
"names": [ "name2" ],
"description": "description2",
"tags": [ "tag" ],
"asynchronous": true,
"function":
(params) => {
const { config } = params;
t.deepEqual(
config,
config2,
`Unexpected config in sync path: ${config}.`
);
return Promise.resolve().then(() => {
t.deepEqual(
config,
config2,
`Unexpected config in async path: ${config}.`
);
});
}
}
],
"strings": {
"string": "# Heading"
}
};
return markdownlint.promises.markdownlint(options).then(() => null);
});
test("customRulesAsyncReadFiles", (t) => {
t.plan(3);
const options = {