mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-12-19 15:30:13 +01:00
Strike through deprecated rule headings
Changes: - Formats the headings of deprecated rules using strikethrough in the 'Rules / Aliases' section of the 'README.md' file and in the 'doc/Rules.md' file. - Updates the 'readme' and 'doc' tests in the 'test/markdownlint-test.js' file to permit their respective rule headings to be formatted using strikethrough. Benefits: - Indicates rule deprecation status 'at a glance'. (fixes #203)
This commit is contained in:
parent
1ae512be69
commit
f3e332eb00
3 changed files with 18 additions and 5 deletions
|
|
@ -19,6 +19,8 @@ const configSchema = require("../schema/markdownlint-config-schema.json");
|
|||
const homepage = packageJson.homepage;
|
||||
const version = packageJson.version;
|
||||
|
||||
const deprecatedRuleNames = [ "MD002" ];
|
||||
|
||||
function promisify(func, ...args) {
|
||||
return new Promise((resolve, reject) => {
|
||||
func(...args, (error, result) => {
|
||||
|
|
@ -1138,9 +1140,12 @@ module.exports.readme = function readme(test) {
|
|||
if (rule) {
|
||||
const ruleName = rule.names[0];
|
||||
const ruleAliases = rule.names.slice(1);
|
||||
const expected = "**[" + ruleName + "](doc/Rules.md#" +
|
||||
let expected = "**[" + ruleName + "](doc/Rules.md#" +
|
||||
ruleName.toLowerCase() + ")** *" +
|
||||
ruleAliases.join("/") + "* - " + rule.description;
|
||||
if (deprecatedRuleNames.includes(ruleName)) {
|
||||
expected = "~~" + expected + "~~";
|
||||
}
|
||||
test.equal(token.content, expected, "Rule mismatch.");
|
||||
}
|
||||
} else if (inTags) {
|
||||
|
|
@ -1197,8 +1202,13 @@ module.exports.doc = function doc(test) {
|
|||
ruleHasAliases = false;
|
||||
test.ok(rule,
|
||||
"Missing rule implementation for " + token.content + ".");
|
||||
const ruleName = rule.names[0];
|
||||
let headingContent = ruleName + " - " + rule.description;
|
||||
if (deprecatedRuleNames.includes(ruleName)) {
|
||||
headingContent = "~~" + headingContent + "~~";
|
||||
}
|
||||
test.equal(token.content,
|
||||
rule.names[0] + " - " + rule.description,
|
||||
headingContent,
|
||||
"Rule mismatch.");
|
||||
ruleUsesParams = rule.function.toString()
|
||||
.match(/params\.config\.[_a-z]*/gi);
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue