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

Change export of rules to include description.

Browse source
This commit is contained in:
David Anson 2015-02-24 23:50:37 -08:00
parent aef1524308
commit 5d35b8dfea
2 changed files with 51 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

7
lib/markdownlint.js
View file

@ -18,12 +18,11 @@ function lintFile(file, options, callback) {
} else { } else {
var lines = contents.split(/\r\n|\n/g); var lines = contents.split(/\r\n|\n/g);
var result = {}; var result = {};
Object.keys(rules).forEach(function forRule(name) { rules.forEach(function forRule(rule) {
var rule = rules[name]; var errors = rule.func(lines);
var errors = rule(lines);
if (errors.length) { if (errors.length) {
errors.sort(numberComparison); errors.sort(numberComparison);
result[name] = errors.filter(uniqueFilterForSorted); result[rule.name] = errors.filter(uniqueFilterForSorted);
} }
}); });
callback(null, result); callback(null, result);

16
lib/rules.js
View file

@ -9,8 +9,11 @@ function padAndTrim(lines) {
""); "");
} }
module.exports = { module.exports = [
"MD031": function MD031(lines) { {
"name": "MD031",
"desc": "Fenced code blocks should be surrounded by blank lines",
"func": function MD031(lines) {
// Some parsers have trouble detecting fenced code blocks without // Some parsers have trouble detecting fenced code blocks without
// surrounding whitespace, so examine the lines directly. // surrounding whitespace, so examine the lines directly.
lines = padAndTrim(lines); lines = padAndTrim(lines);
@ -26,9 +29,13 @@ module.exports = {
} }
}); });
return errors; return errors;
}
}, },
"MD032": function MD032(lines) { {
"name": "MD032",
"desc": "Lists should be surrounded by blank lines",
"func": function MD032(lines) {
// Some parsers have trouble detecting lists without surrounding // Some parsers have trouble detecting lists without surrounding
// whitespace, so examine the lines directly. // whitespace, so examine the lines directly.
var errors = []; var errors = [];
@ -53,4 +60,5 @@ module.exports = {
}); });
return errors; return errors;
} }
}; }
];