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

Remove abbreviations from rule metadata to clarify API.

Browse source
This commit is contained in:
David Anson 2018-01-18 21:34:30 -08:00
parent 513a1351a5
commit 49e36f817c
4 changed files with 92 additions and 90 deletions
Download patch file Download diff file Expand all files Collapse all files

8
lib/markdownlint.js
View file

@ -21,7 +21,7 @@ rules.forEach(function forRule(rule) {
// The following is useful for updating README.md
// console.log(
// "* **[" + ruleName + "](doc/Rules.md#" + ruleName.toLowerCase() +
// ")** *" + ruleAliases.join(", ") + "* - " + rule.desc);
// ")** *" + ruleAliases.join(", ") + "* - " + rule.description);
rule.tags.forEach(function forTag(tag) {
var tagUpper = tag.toUpperCase();
var ruleNames = idUpperToRuleNames[tagUpper] || [];
@ -73,7 +73,7 @@ Results.prototype.toString = function resultsToString(useAlias) {
file + ": " +
lineNumber + ": " +
rule.names[useAlias ? 1 : 0] + " " +
rule.desc;
rule.description;
results.push(result);
});
});
@ -241,7 +241,7 @@ function lintContent(
"range": errorInfo.range || null
});
}
rule.func(params, onError);
rule.function(params, onError);
// Record any errors (significant performance benefit from length check)
if (errors.length) {
errors.sort(lineNumberComparison);
@ -262,7 +262,7 @@ function lintContent(
} else {
errorObject.ruleNames = rule.names;
}
errorObject.ruleDescription = rule.desc;
errorObject.ruleDescription = rule.description;
errorObject.errorDetail = error.detail;
errorObject.errorContext = error.context;
errorObject.errorRange = error.range;