Update MD022/blanks-around-headings to allow passing -1 for lines_abo…

…ve/lines_below to allow any number of blank lines in that direction (fixes #546).
DavidAnson · Aug 6, 2023 · 8098410 · 8098410
1 parent f079df1
commit 8098410
Show file tree

Hide file tree

Showing 12 changed files with 273 additions and 58 deletions.
diff --git a/demo/markdownlint-browser.js b/demo/markdownlint-browser.js
@@ -4177,25 +4177,33 @@ module.exports = {
         var startLine = heading.startLine,
           endLine = heading.endLine;
         var line = lines[startLine - 1].trim();
-        var actualAbove = 0;
-        for (var i = 0; i < linesAbove; i++) {
-          if (isBlankLine(lines[startLine - 2 - i])) {
-            actualAbove++;
+
+        // Check lines above
+        if (linesAbove >= 0) {
+          var actualAbove = 0;
+          for (var i = 0; i < linesAbove; i++) {
+            if (isBlankLine(lines[startLine - 2 - i])) {
+              actualAbove++;
+            }
           }
+          addErrorDetailIf(onError, startLine, linesAbove, actualAbove, "Above", line, null, {
+            "insertText": getBlockQuote(lines[startLine - 2], linesAbove - actualAbove)
+          });
         }
-        addErrorDetailIf(onError, startLine, linesAbove, actualAbove, "Above", line, null, {
-          "insertText": getBlockQuote(lines[startLine - 2], linesAbove - actualAbove)
-        });
-        var actualBelow = 0;
-        for (var _i = 0; _i < linesBelow; _i++) {
-          if (isBlankLine(lines[endLine + _i])) {
-            actualBelow++;
+
+        // Check lines below
+        if (linesBelow >= 0) {
+          var actualBelow = 0;
+          for (var _i = 0; _i < linesBelow; _i++) {
+            if (isBlankLine(lines[endLine + _i])) {
+              actualBelow++;
+            }
           }
+          addErrorDetailIf(onError, startLine, linesBelow, actualBelow, "Below", line, null, {
+            "lineNumber": endLine + 1,
+            "insertText": getBlockQuote(lines[endLine], linesBelow - actualBelow)
+          });
         }
-        addErrorDetailIf(onError, startLine, linesBelow, actualBelow, "Below", line, null, {
-          "lineNumber": endLine + 1,
-          "insertText": getBlockQuote(lines[endLine], linesBelow - actualBelow)
-        });
       }
     } catch (err) {
       _iterator.e(err);

diff --git a/doc-build/md022.md b/doc-build/md022.md
@@ -23,7 +23,9 @@ Some more text
 ```
 
 The `lines_above` and `lines_below` parameters can be used to specify a
-different number of blank lines (including 0) above or below each heading.
+different number of blank lines (including `0`) above or below each heading. If
+the value `-1` is used for either parameter, any number of blank lines is
+allowed.
 
 Note: If `lines_above` or `lines_below` are configured to require more than one
 blank line, [MD012/no-multiple-blanks](md012.md) should also be customized.

diff --git a/doc/Rules.md b/doc/Rules.md
@@ -836,7 +836,9 @@ Some more text
 ```
 
 The `lines_above` and `lines_below` parameters can be used to specify a
-different number of blank lines (including 0) above or below each heading.
+different number of blank lines (including `0`) above or below each heading. If
+the value `-1` is used for either parameter, any number of blank lines is
+allowed.
 
 Note: If `lines_above` or `lines_below` are configured to require more than one
 blank line, [MD012/no-multiple-blanks](md012.md) should also be customized.

diff --git a/doc/md022.md b/doc/md022.md
@@ -36,7 +36,9 @@ Some more text
 ```
 
 The `lines_above` and `lines_below` parameters can be used to specify a
-different number of blank lines (including 0) above or below each heading.
+different number of blank lines (including `0`) above or below each heading. If
+the value `-1` is used for either parameter, any number of blank lines is
+allowed.
 
 Note: If `lines_above` or `lines_below` are configured to require more than one
 blank line, [MD012/no-multiple-blanks](md012.md) should also be customized.

diff --git a/lib/md022.js b/lib/md022.js
@@ -32,45 +32,53 @@ module.exports = {
     for (const heading of headings) {
       const { startLine, endLine } = heading;
       const line = lines[startLine - 1].trim();
-      let actualAbove = 0;
-      for (let i = 0; i < linesAbove; i++) {
-        if (isBlankLine(lines[startLine - 2 - i])) {
-          actualAbove++;
+
+      // Check lines above
+      if (linesAbove >= 0) {
+        let actualAbove = 0;
+        for (let i = 0; i < linesAbove; i++) {
+          if (isBlankLine(lines[startLine - 2 - i])) {
+            actualAbove++;
+          }
         }
+        addErrorDetailIf(
+          onError,
+          startLine,
+          linesAbove,
+          actualAbove,
+          "Above",
+          line,
+          null,
+          {
+            "insertText":
+              getBlockQuote(lines[startLine - 2], linesAbove - actualAbove)
+          }
+        );
       }
-      addErrorDetailIf(
-        onError,
-        startLine,
-        linesAbove,
-        actualAbove,
-        "Above",
-        line,
-        null,
-        {
-          "insertText":
-            getBlockQuote(lines[startLine - 2], linesAbove - actualAbove)
-        }
-      );
-      let actualBelow = 0;
-      for (let i = 0; i < linesBelow; i++) {
-        if (isBlankLine(lines[endLine + i])) {
-          actualBelow++;
+
+      // Check lines below
+      if (linesBelow >= 0) {
+        let actualBelow = 0;
+        for (let i = 0; i < linesBelow; i++) {
+          if (isBlankLine(lines[endLine + i])) {
+            actualBelow++;
+          }
         }
+        addErrorDetailIf(
+          onError,
+          startLine,
+          linesBelow,
+          actualBelow,
+          "Below",
+          line,
+          null,
+          {
+            "lineNumber": endLine + 1,
+            "insertText":
+              getBlockQuote(lines[endLine], linesBelow - actualBelow)
+          }
+        );
       }
-      addErrorDetailIf(
-        onError,
-        startLine,
-        linesBelow,
-        actualBelow,
-        "Below",
-        line,
-        null,
-        {
-          "lineNumber": endLine + 1,
-          "insertText":
-            getBlockQuote(lines[endLine], linesBelow - actualBelow)
-        }
-      );
     }
   }
 };
diff --git a/schema/build-config-schema.js b/schema/build-config-schema.js
@@ -230,13 +230,13 @@ for (const rule of rules) {
         "lines_above": {
           "description": "Blank lines above heading",
           "type": "integer",
-          "minimum": 0,
+          "minimum": -1,
           "default": 1
         },
         "lines_below": {
           "description": "Blank lines below heading",
           "type": "integer",
-          "minimum": 0,
+          "minimum": -1,
           "default": 1
         }
       };

diff --git a/schema/markdownlint-config-schema.json b/schema/markdownlint-config-schema.json
@@ -362,13 +362,13 @@
         "lines_above": {
           "description": "Blank lines above heading",
           "type": "integer",
-          "minimum": 0,
+          "minimum": -1,
           "default": 1
         },
         "lines_below": {
           "description": "Blank lines below heading",
           "type": "integer",
-          "minimum": 0,
+          "minimum": -1,
           "default": 1
         }
       },

diff --git a/test/blanks-around-headings--1-1.md b/test/blanks-around-headings--1-1.md
@@ -0,0 +1,33 @@
+# Blanks Around Headings
+
+## Apple
+
+Text
+## Banana
+
+Text
+
+## Cherry
+
+Text
+
+
+## Durian ##
+
+Text
+
+Elderberry {MD022}
+------------------
+Text
+
+---
+## Fig
+
+<!-- markdownlint-configure-file {
+  "heading-style": false,
+  "no-multiple-blanks": false,
+  "blanks-around-headings": {
+    "lines_above": -1,
+    "lines_below": 1
+  }
+} -->
diff --git a/test/blanks-around-headings-1--1.md b/test/blanks-around-headings-1--1.md
@@ -0,0 +1,35 @@
+# Blanks Around Headings
+
+## Apple
+Text
+
+## Banana
+
+Text
+
+## Cherry
+
+
+Text
+
+---
+## Durian {MD022} ##
+
+Text
+
+---
+
+Elderberry
+------------------
+Text
+
+## Fig
+
+<!-- markdownlint-configure-file {
+  "heading-style": false,
+  "no-multiple-blanks": false,
+  "blanks-around-headings": {
+    "lines_above": 1,
+    "lines_below": -1
+  }
+} -->
diff --git a/test/markdownlint-test.js b/test/markdownlint-test.js
@@ -919,7 +919,7 @@ test("readme", (t) => new Promise((resolve) => {
 }));
 
 test("validateJsonUsingConfigSchemaStrict", (t) => {
-  t.plan(156);
+  t.plan(158);
   const configRe =
     /^[\s\S]*<!-- markdownlint-configure-file ([\s\S]*) -->[\s\S]*$/;
   const ignoreFiles = new Set([