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

Add detail to MD029/ol-prefix message to help distinguish 1/1/1 from 1/2/3.

Browse source
This commit is contained in:
David Anson 2017-11-20 21:49:22 -08:00
parent 0fd322a380
commit f910fa0cb1
3 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

5
lib/markdownlint.js
View file

@ -235,11 +235,12 @@ function lintContent(
addError(lineNumber, detail); addError(lineNumber, detail);
}; };
errors.addDetailIf = errors.addDetailIf =
function addDetailIf(lineNumber, expected, actual, range) { function addDetailIf(lineNumber, expected, actual, detail, range) {
if (expected !== actual) { if (expected !== actual) {
addError( addError(
lineNumber, lineNumber,
"Expected: " + expected + "; Actual: " + actual, "Expected: " + expected + "; Actual: " + actual +
(detail ? "; " + detail : ""),
null, null,
range); range);
} }

5
lib/rules.js
View file

@ -752,7 +752,8 @@ module.exports = [
list.items.forEach(function forItem(item) { list.items.forEach(function forItem(item) {
var match = /^[\s>]*([^.)]*)[.)]/.exec(item.line); var match = /^[\s>]*([^.)]*)[.)]/.exec(item.line);
errors.addDetailIf(item.lineNumber, errors.addDetailIf(item.lineNumber,
String(number), !match || match[1]); String(number), !match || match[1],
"Style: " + (style === "one" ? "1/1/1" : "1/2/3"));
if (style === "ordered") { if (style === "ordered") {
number++; number++;
} }
@ -1187,7 +1188,7 @@ module.exports = [
if (names.indexOf(wordMatch) === -1) { if (names.indexOf(wordMatch) === -1) {
var lineNumber = token.lineNumber + index + fenceOffset; var lineNumber = token.lineNumber + index + fenceOffset;
var range = [ match.index + 1, wordMatch.length ]; var range = [ match.index + 1, wordMatch.length ];
errors.addDetailIf(lineNumber, name, match[1], range); errors.addDetailIf(lineNumber, name, match[1], null, range);
} }
} }
} }

2
test/detailed-results-MD022-MD030.results.json
View file

@ -94,7 +94,7 @@
"ruleName": "MD029", "ruleName": "MD029",
"ruleAlias": "ol-prefix", "ruleAlias": "ol-prefix",
"ruleDescription": "Ordered list item prefix", "ruleDescription": "Ordered list item prefix",
"errorDetail": "Expected: 1; Actual: 2", "errorDetail": "Expected: 1; Actual: 2; Style: 1/1/1",
"errorContext": null, "errorContext": null,
"errorRange": [1, 4] "errorRange": [1, 4]
}, },