Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-22 17:00:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

feat: implement autofix for md029

Browse source 
Add support for auto-fixing MD029 violations.

Close #949
This commit is contained in:
Marco Ferrari 2025-08-20 16:24:46 +00:00
parent 3532e3110a
commit cec6c7e95d
12 changed files with 1018 additions and 177 deletions
Download patch file Download diff file Expand all files Collapse all files

27
lib/md029.mjs
View file

@ -14,10 +14,14 @@ const listStyleExamples = {
* Gets the value of an ordered list item prefix token.
*
* @param {import("markdownlint").MicromarkToken} listItemPrefix List item prefix token.
* @returns {number} List item value.
* @returns {{column: number, value: number}} List item column, and value.
*/
function getOrderedListItemValue(listItemPrefix) {
return Number(getDescendantsByType(listItemPrefix, [ "listItemValue" ])[0].text);
const listItemValue = getDescendantsByType(listItemPrefix, [ "listItemValue" ])[0];
return {
"column": listItemValue.startColumn,
"value": Number(listItemValue.text)
};
}
/** @type {import("markdownlint").Rule} */
@ -34,11 +38,11 @@ export default {
let incrementing = false;
// Check for incrementing number pattern 1/2/3 or 0/1/2
if (listItemPrefixes.length >= 2) {
const firstValue = getOrderedListItemValue(listItemPrefixes[0]);
const secondValue = getOrderedListItemValue(listItemPrefixes[1]);
if ((secondValue !== 1) || (firstValue === 0)) {
const first = getOrderedListItemValue(listItemPrefixes[0]);
const second = getOrderedListItemValue(listItemPrefixes[1]);
if ((second.value !== 1) || (first.value === 0)) {
incrementing = true;
if (firstValue === 0) {
if (first.value === 0) {
expected = 0;
}
}
@ -54,7 +58,13 @@ export default {
}
// Validate each list item marker
for (const listItemPrefix of listItemPrefixes) {
const actual = getOrderedListItemValue(listItemPrefix);
const orderedListItemValue = getOrderedListItemValue(listItemPrefix);
const actual = orderedListItemValue.value;
const fixInfo = {
"editColumn": orderedListItemValue.column,
"deleteCount": orderedListItemValue.value.toString().length,
"insertText": expected.toString()
};
addErrorDetailIf(
onError,
listItemPrefix.startLine,
@ -62,7 +72,8 @@ export default {
actual,
"Style: " + listStyleExamples[listStyle],
undefined,
[ listItemPrefix.startColumn, listItemPrefix.endColumn - listItemPrefix.startColumn ]
[ listItemPrefix.startColumn, listItemPrefix.endColumn - listItemPrefix.startColumn ],
fixInfo
);
if (listStyle === "ordered") {
expected++;