Update MD009/no-trailing-spaces with code_blocks parameter to allow reporting/fixing trailing spaces in indented/fenced code blocks (fixes #1181).

Author: DavidAnson

doc-build/md009.md

@@ -1,21 +1,19 @@
 This rule is triggered on any lines that end with unexpected whitespace. To fix
 this, remove the trailing space from the end of the line.
 
-Note: Trailing space is allowed in indented and fenced code blocks because some
-languages require it.
-
 The `br_spaces` parameter allows an exception to this rule for a specific number
 of trailing spaces, typically used to insert an explicit line break. The default
-value allows 2 spaces to indicate a hard break (\<br> element).
+value allows 2 spaces to indicate a hard break (\<br> element). (You must set
+`br_spaces` to a value >= 2 for this parameter to take effect. Setting
+`br_spaces` to 1 behaves the same as 0, disallowing any trailing spaces.)
 
-Note: You must set `br_spaces` to a value >= 2 for this parameter to take
-effect. Setting `br_spaces` to 1 behaves the same as 0, disallowing any trailing
-spaces.
+By default, trailing space is allowed in indented and fenced code blocks because
+some programming languages require that. To report such instances, set the
+`code_blocks` parameter to `true`.
 
 By default, this rule will not trigger when the allowed number of spaces is
 used, even when it doesn't create a hard break (for example, at the end of a
-paragraph). To report such instances as well, set the `strict` parameter to
-`true`.
+paragraph). To report such instances, set the `strict` parameter to `true`.
 
 ```markdown
 Text text text

doc/Rules.md

@@ -295,6 +295,7 @@ Aliases: `no-trailing-spaces`
 Parameters:
 
 - `br_spaces`: Spaces for line break (`integer`, default `2`)
+- `code_blocks`: Include code blocks (`boolean`, default `false`)
 - `list_item_empty_lines`: Allow spaces for empty lines in list items
   (`boolean`, default `false`)
 - `strict`: Include unnecessary breaks (`boolean`, default `false`)
@@ -304,21 +305,19 @@ Fixable: Some violations can be fixed by tooling
 This rule is triggered on any lines that end with unexpected whitespace. To fix
 this, remove the trailing space from the end of the line.
 
-Note: Trailing space is allowed in indented and fenced code blocks because some
-languages require it.
-
 The `br_spaces` parameter allows an exception to this rule for a specific number
 of trailing spaces, typically used to insert an explicit line break. The default
-value allows 2 spaces to indicate a hard break (\<br> element).
+value allows 2 spaces to indicate a hard break (\<br> element). (You must set
+`br_spaces` to a value >= 2 for this parameter to take effect. Setting
+`br_spaces` to 1 behaves the same as 0, disallowing any trailing spaces.)
 
-Note: You must set `br_spaces` to a value >= 2 for this parameter to take
-effect. Setting `br_spaces` to 1 behaves the same as 0, disallowing any trailing
-spaces.
+By default, trailing space is allowed in indented and fenced code blocks because
+some programming languages require that. To report such instances, set the
+`code_blocks` parameter to `true`.
 
 By default, this rule will not trigger when the allowed number of spaces is
 used, even when it doesn't create a hard break (for example, at the end of a
-paragraph). To report such instances as well, set the `strict` parameter to
-`true`.
+paragraph). To report such instances, set the `strict` parameter to `true`.
 
 ```markdown
 Text text text

doc/md009.md

@@ -7,6 +7,7 @@ Aliases: `no-trailing-spaces`
 Parameters:
 
 - `br_spaces`: Spaces for line break (`integer`, default `2`)
+- `code_blocks`: Include code blocks (`boolean`, default `false`)
 - `list_item_empty_lines`: Allow spaces for empty lines in list items
   (`boolean`, default `false`)
 - `strict`: Include unnecessary breaks (`boolean`, default `false`)
@@ -16,21 +17,19 @@ Fixable: Some violations can be fixed by tooling
 This rule is triggered on any lines that end with unexpected whitespace. To fix
 this, remove the trailing space from the end of the line.
 
-Note: Trailing space is allowed in indented and fenced code blocks because some
-languages require it.
-
 The `br_spaces` parameter allows an exception to this rule for a specific number
 of trailing spaces, typically used to insert an explicit line break. The default
-value allows 2 spaces to indicate a hard break (\<br> element).
+value allows 2 spaces to indicate a hard break (\<br> element). (You must set
+`br_spaces` to a value >= 2 for this parameter to take effect. Setting
+`br_spaces` to 1 behaves the same as 0, disallowing any trailing spaces.)
 
-Note: You must set `br_spaces` to a value >= 2 for this parameter to take
-effect. Setting `br_spaces` to 1 behaves the same as 0, disallowing any trailing
-spaces.
+By default, trailing space is allowed in indented and fenced code blocks because
+some programming languages require that. To report such instances, set the
+`code_blocks` parameter to `true`.
 
 By default, this rule will not trigger when the allowed number of spaces is
 used, even when it doesn't create a hard break (for example, at the end of a
-paragraph). To report such instances as well, set the `strict` parameter to
-`true`.
+paragraph). To report such instances, set the `strict` parameter to `true`.
 
 ```markdown
 Text text text

lib/configuration-strict.d.ts

@@ -245,6 +245,10 @@ export interface ConfigurationStrict {
          * Spaces for line break
          */
         br_spaces?: number;
+        /**
+         * Include code blocks
+         */
+        code_blocks?: boolean;
         /**
          * Allow spaces for empty lines in list items
          */
@@ -273,6 +277,10 @@ export interface ConfigurationStrict {
          * Spaces for line break
          */
         br_spaces?: number;
+        /**
+         * Include code blocks
+         */
+        code_blocks?: boolean;
         /**
          * Allow spaces for empty lines in list items
          */

lib/md009.mjs

@@ -13,14 +13,18 @@ export default {
   "function": function MD009(params, onError) {
     let brSpaces = params.config.br_spaces;
     brSpaces = Number((brSpaces === undefined) ? 2 : brSpaces);
+    const codeBlocks = params.config.code_blocks;
+    const includeCode = (codeBlocks === undefined) ? false : !!codeBlocks;
     const listItemEmptyLines = !!params.config.list_item_empty_lines;
     const strict = !!params.config.strict;
     const codeBlockLineNumbers = new Set();
-    for (const codeBlock of filterByTypesCached([ "codeFenced" ])) {
-      addRangeToSet(codeBlockLineNumbers, codeBlock.startLine + 1, codeBlock.endLine - 1);
-    }
-    for (const codeBlock of filterByTypesCached([ "codeIndented" ])) {
-      addRangeToSet(codeBlockLineNumbers, codeBlock.startLine, codeBlock.endLine);
+    if (!includeCode) {
+      for (const codeBlock of filterByTypesCached([ "codeFenced" ])) {
+        addRangeToSet(codeBlockLineNumbers, codeBlock.startLine + 1, codeBlock.endLine - 1);
+      }
+      for (const codeBlock of filterByTypesCached([ "codeIndented" ])) {
+        addRangeToSet(codeBlockLineNumbers, codeBlock.startLine, codeBlock.endLine);
+      }
     }
     const listItemLineNumbers = new Set();
     if (listItemEmptyLines) {

schema/.markdownlint.jsonc

@@ -42,6 +42,8 @@
   "MD009": {
     // Spaces for line break
     "br_spaces": 2,
+    // Include code blocks
+    "code_blocks": false,
     // Allow spaces for empty lines in list items
     "list_item_empty_lines": false,
     // Include unnecessary breaks

schema/.markdownlint.yaml

@@ -37,6 +37,8 @@ MD007:
 MD009:
   # Spaces for line break
   br_spaces: 2
+  # Include code blocks
+  code_blocks: false
   # Allow spaces for empty lines in list items
   list_item_empty_lines: false
   # Include unnecessary breaks

schema/build-config-schema.mjs

@@ -161,6 +161,12 @@ for (const rule of rules) {
         "default": 2
       };
       // @ts-ignore
+      subscheme.properties.code_blocks = {
+        "description": "Include code blocks",
+        "type": "boolean",
+        "default": false
+      };
+      // @ts-ignore
       subscheme.properties.list_item_empty_lines = {
         "description": "Allow spaces for empty lines in list items",
         "type": "boolean",

schema/markdownlint-config-schema-strict.json

@@ -512,6 +512,11 @@
               "minimum": 0,
               "default": 2
             },
+            "code_blocks": {
+              "description": "Include code blocks",
+              "type": "boolean",
+              "default": false
+            },
             "list_item_empty_lines": {
               "description": "Allow spaces for empty lines in list items",
               "type": "boolean",
@@ -563,6 +568,11 @@
               "minimum": 0,
               "default": 2
             },
+            "code_blocks": {
+              "description": "Include code blocks",
+              "type": "boolean",
+              "default": false
+            },
             "list_item_empty_lines": {
               "description": "Allow spaces for empty lines in list items",
               "type": "boolean",

schema/markdownlint-config-schema.json

@@ -512,6 +512,11 @@
               "minimum": 0,
               "default": 2
             },
+            "code_blocks": {
+              "description": "Include code blocks",
+              "type": "boolean",
+              "default": false
+            },
             "list_item_empty_lines": {
               "description": "Allow spaces for empty lines in list items",
               "type": "boolean",
@@ -563,6 +568,11 @@
               "minimum": 0,
               "default": 2
             },
+            "code_blocks": {
+              "description": "Include code blocks",
+              "type": "boolean",
+              "default": false
+            },
             "list_item_empty_lines": {
               "description": "Allow spaces for empty lines in list items",
               "type": "boolean",