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

Update MD022/blanks-around-headings to allow specifying a different number of blank lines for each heading level (fixes #504).

Browse source
This commit is contained in:
David Anson 2023-08-08 22:56:47 -07:00
parent bdc9d357f3
commit d9de1dd22f
13 changed files with 690 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

58
lib/md022.js
View file

@ -4,7 +4,23 @@
const { addErrorDetailIf, blockquotePrefixRe, isBlankLine } =
require("../helpers");
const { filterByTypes } = require("../helpers/micromark.cjs");
const { filterByTypes, getHeadingLevel } =
require("../helpers/micromark.cjs");
const defaultLines = 1;
const getLinesFunction = (linesParam) => {
if (Array.isArray(linesParam)) {
const linesArray = new Array(6).fill(defaultLines);
for (const [ index, value ] of [ ...linesParam.entries() ].slice(0, 6)) {
linesArray[index] = value;
}
return (heading) => linesArray[getHeadingLevel(heading) - 1];
}
// Coerce linesParam to a number
const lines = (linesParam === undefined) ? defaultLines : Number(linesParam);
return () => lines;
};
const getBlockQuote = (str, count) => (
(str || "")
@ -20,10 +36,8 @@ module.exports = {
"description": "Headings should be surrounded by blank lines",
"tags": [ "headings", "headers", "blank_lines" ],
"function": function MD022(params, onError) {
let linesAbove = params.config.lines_above;
linesAbove = Number((linesAbove === undefined) ? 1 : linesAbove);
let linesBelow = params.config.lines_below;
linesBelow = Number((linesBelow === undefined) ? 1 : linesBelow);
const getLinesAbove = getLinesFunction(params.config.lines_above);
const getLinesBelow = getLinesFunction(params.config.lines_below);
const { lines, parsers } = params;
const headings = filterByTypes(
parsers.micromark.tokens,
@ -34,12 +48,15 @@ module.exports = {
const line = lines[startLine - 1].trim();
// Check lines above
const linesAbove = getLinesAbove(heading);
if (linesAbove >= 0) {
let actualAbove = 0;
for (let i = 0; i < linesAbove; i++) {
if (isBlankLine(lines[startLine - 2 - i])) {
actualAbove++;
}
for (
let i = 0;
(i < linesAbove) && isBlankLine(lines[startLine - 2 - i]);
i++
) {
actualAbove++;
}
addErrorDetailIf(
onError,
@ -50,19 +67,24 @@ module.exports = {
line,
null,
{
"insertText":
getBlockQuote(lines[startLine - 2], linesAbove - actualAbove)
"insertText": getBlockQuote(
lines[startLine - 2],
linesAbove - actualAbove
)
}
);
}
// Check lines below
const linesBelow = getLinesBelow(heading);
if (linesBelow >= 0) {
let actualBelow = 0;
for (let i = 0; i < linesBelow; i++) {
if (isBlankLine(lines[endLine + i])) {
actualBelow++;
}
for (
let i = 0;
(i < linesBelow) && isBlankLine(lines[endLine + i]);
i++
) {
actualBelow++;
}
addErrorDetailIf(
onError,
@ -74,8 +96,10 @@ module.exports = {
null,
{
"lineNumber": endLine + 1,
"insertText":
getBlockQuote(lines[endLine], linesBelow - actualBelow)
"insertText": getBlockQuote(
lines[endLine],
linesBelow - actualBelow
)
}
);
}