markdownlint 0.24.0 → 0.26.0

package/lib/md004.js

@@ -26,12 +26,12 @@ module.exports = {
     const style = String(params.config.style || "consistent");
     let expectedStyle = style;
     const nestingStyles = [];
-    flattenedLists().forEach((list) => {
+    for (const list of flattenedLists()) {
       if (list.unordered) {
         if (expectedStyle === "consistent") {
           expectedStyle = unorderedListStyleFor(list.items[0]);
         }
-        list.items.forEach((item) => {
+        for (const item of list.items) {
           const itemStyle = unorderedListStyleFor(item);
           if (style === "sublist") {
             const nesting = list.nesting;
@@ -69,8 +69,8 @@ module.exports = {
             range,
             fixInfo
           );
-        });
+        }
       }
-    });
+    }
   }
 };

package/lib/md005.js

@@ -11,12 +11,12 @@ module.exports = {
   "description": "Inconsistent indentation for list items at the same level",
   "tags": [ "bullet", "ul", "indentation" ],
   "function": function MD005(params, onError) {
-    flattenedLists().forEach((list) => {
+    for (const list of flattenedLists()) {
       const expectedIndent = list.indent;
       let expectedEnd = 0;
       let actualEnd = -1;
       let endMatching = false;
-      list.items.forEach((item) => {
+      for (const item of list.items) {
         const { line, lineNumber } = item;
         const actualIndent = indentFor(item);
         let match = null;
@@ -63,7 +63,7 @@ module.exports = {
             }
           }
         }
-      });
-    });
+      }
+    }
   }
 };

package/lib/md006.js

@@ -12,9 +12,9 @@ module.exports = {
     "Consider starting bulleted lists at the beginning of the line",
   "tags": [ "bullet", "ul", "indentation" ],
   "function": function MD006(params, onError) {
-    flattenedLists().forEach((list) => {
+    for (const list of flattenedLists()) {
       if (list.unordered && !list.nesting && (list.indent !== 0)) {
-        list.items.forEach((item) => {
+        for (const item of list.items) {
           const { lineNumber, line } = item;
           addErrorDetailIf(
             onError,
@@ -27,8 +27,8 @@ module.exports = {
             {
               "deleteCount": line.length - line.trimStart().length
             });
-        });
+        }
       }
-    });
+    }
   }
 };

package/lib/md007.js

@@ -13,12 +13,14 @@ module.exports = {
   "function": function MD007(params, onError) {
     const indent = Number(params.config.indent || 2);
     const startIndented = !!params.config.start_indented;
-    flattenedLists().forEach((list) => {
+    const startIndent = Number(params.config.start_indent || indent);
+    for (const list of flattenedLists()) {
       if (list.unordered && list.parentsUnordered) {
-        list.items.forEach((item) => {
+        for (const item of list.items) {
           const { lineNumber, line } = item;
-          const expectedNesting = list.nesting + (startIndented ? 1 : 0);
-          const expectedIndent = expectedNesting * indent;
+          const expectedIndent =
+            (startIndented ? startIndent : 0) +
+            (list.nesting * indent);
           const actualIndent = indentFor(item);
           let range = null;
           let editColumn = 1;
@@ -40,8 +42,8 @@ module.exports = {
               "deleteCount": actualIndent,
               "insertText": "".padEnd(expectedIndent)
             });
-        });
+        }
       }
-    });
+    }
   }
 };

package/lib/md009.js

@@ -2,8 +2,8 @@
 
 "use strict";
 
-const { addError, filterTokens, forEachInlineCodeSpan, forEachLine,
-  includesSorted, newLineRe, numericSortAscending } = require("../helpers");
+const { addError, filterTokens, forEachLine, includesSorted,
+  numericSortAscending } = require("../helpers");
 const { lineMetadata } = require("./cache");
 
 module.exports = {
@@ -32,19 +32,26 @@ module.exports = {
           paragraphLineNumbers.push(i + 1);
         }
       });
-      paragraphLineNumbers.sort(numericSortAscending);
+      const addLineNumberRange = (start, end) => {
+        for (let i = start; i < end; i++) {
+          codeInlineLineNumbers.push(i);
+        }
+      };
       filterTokens(params, "inline", (token) => {
-        if (token.children.some((child) => child.type === "code_inline")) {
-          const tokenLines = params.lines.slice(token.map[0], token.map[1]);
-          forEachInlineCodeSpan(tokenLines.join("\n"), (code, lineIndex) => {
-            const codeLineCount = code.split(newLineRe).length;
-            for (let i = 0; i < codeLineCount; i++) {
-              codeInlineLineNumbers.push(token.lineNumber + lineIndex + i);
-            }
-          });
+        let start = 0;
+        for (const child of token.children) {
+          if (start > 0) {
+            addLineNumberRange(start, child.lineNumber);
+            start = 0;
+          }
+          if (child.type === "code_inline") {
+            start = child.lineNumber;
+          }
+        }
+        if (start > 0) {
+          addLineNumberRange(start, token.map[1]);
         }
       });
-      codeInlineLineNumbers.sort(numericSortAscending);
     }
     const expected = (brSpaces < 2) ? 0 : brSpaces;
     forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
@@ -67,7 +74,7 @@ module.exports = {
           lineNumber,
           "Expected: " + (expected === 0 ? "" : "0 or ") +
             expected + "; Actual: " + trailingSpaces,
-          null,
+          undefined,
           [ column, trailingSpaces ],
           {
             "editColumn": column,

package/lib/md010.js

@@ -2,8 +2,9 @@
 
 "use strict";
 
-const { addError, forEachLine } = require("../helpers");
-const { lineMetadata } = require("./cache");
+const { addError, filterTokens, forEachLine, withinAnyRange } =
+  require("../helpers");
+const { codeBlockAndSpanRanges, lineMetadata } = require("./cache");
 
 const tabRe = /\t+/g;
 
@@ -13,28 +14,45 @@ module.exports = {
   "tags": [ "whitespace", "hard_tab" ],
   "function": function MD010(params, onError) {
     const codeBlocks = params.config.code_blocks;
-    const includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
+    const includeCode = (codeBlocks === undefined) ? true : !!codeBlocks;
+    const ignoreCodeLanguages = new Set(
+      (params.config.ignore_code_languages || [])
+        .map((language) => language.toLowerCase())
+    );
     const spacesPerTab = params.config.spaces_per_tab;
     const spaceMultiplier = (spacesPerTab === undefined) ?
       1 :
       Math.max(0, Number(spacesPerTab));
+    const exclusions = includeCode ? [] : codeBlockAndSpanRanges();
+    filterTokens(params, "fence", (token) => {
+      const language = token.info.trim().toLowerCase();
+      if (ignoreCodeLanguages.has(language)) {
+        for (let i = token.map[0] + 1; i < token.map[1] - 1; i++) {
+          exclusions.push([ i, 0, params.lines[i].length ]);
+        }
+      }
+    });
     forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
-      if (!inCode || includeCodeBlocks) {
+      if (includeCode || !inCode) {
         let match = null;
         while ((match = tabRe.exec(line)) !== null) {
-          const column = match.index + 1;
+          const { index } = match;
+          const column = index + 1;
           const length = match[0].length;
-          addError(
-            onError,
-            lineIndex + 1,
-            "Column: " + column,
-            null,
-            [ column, length ],
-            {
-              "editColumn": column,
-              "deleteCount": length,
-              "insertText": "".padEnd(length * spaceMultiplier)
-            });
+          if (!withinAnyRange(exclusions, lineIndex, index, length)) {
+            addError(
+              onError,
+              lineIndex + 1,
+              "Column: " + column,
+              null,
+              [ column, length ],
+              {
+                "editColumn": column,
+                "deleteCount": length,
+                "insertText": "".padEnd(length * spaceMultiplier)
+              }
+            );
+          }
         }
       }
     });

package/lib/md011.js

@@ -2,8 +2,8 @@
 
 "use strict";
 
-const { addError, forEachLine, overlapsAnyRange } = require("../helpers");
-const { inlineCodeSpanRanges, lineMetadata } = require("./cache");
+const { addError, forEachLine, withinAnyRange } = require("../helpers");
+const { codeBlockAndSpanRanges, lineMetadata } = require("./cache");
 
 const reversedLinkRe =
   /(^|[^\\])\(([^)]+)\)\[([^\]^][^\]]*)](?!\()/g;
@@ -13,7 +13,7 @@ module.exports = {
   "description": "Reversed link syntax",
   "tags": [ "links" ],
   "function": function MD011(params, onError) {
-    const exclusions = inlineCodeSpanRanges();
+    const exclusions = codeBlockAndSpanRanges();
     forEachLine(lineMetadata(), (line, lineIndex, inCode, onFence) => {
       if (!inCode && !onFence) {
         let match = null;
@@ -24,7 +24,7 @@ module.exports = {
           if (
             !linkText.endsWith("\\") &&
             !linkDestination.endsWith("\\") &&
-            !overlapsAnyRange(exclusions, lineIndex, index, length)
+            !withinAnyRange(exclusions, lineIndex, index, length)
           ) {
             addError(
               onError,

package/lib/md013.js

@@ -3,13 +3,12 @@
 "use strict";
 
 const { addErrorDetailIf, filterTokens, forEachHeading, forEachLine,
-  includesSorted } = require("../helpers");
+  includesSorted, linkReferenceDefinitionRe } = require("../helpers");
 const { lineMetadata } = require("./cache");
 
 const longLineRePrefix = "^.{";
 const longLineRePostfixRelaxed = "}.*\\s.*$";
 const longLineRePostfixStrict = "}.+$";
-const labelRe = /^\s*\[.*[^\\]]:/;
 const linkOrImageOnlyLineRe = /^[es]*(lT?L|I)[ES]*$/;
 const sternModeRe = /^([#>\s]*\s)?\S*$/;
 const tokenTypeMap = {
@@ -59,11 +58,11 @@ module.exports = {
     const linkOnlyLineNumbers = [];
     filterTokens(params, "inline", (token) => {
       let childTokenTypes = "";
-      token.children.forEach((child) => {
+      for (const child of token.children) {
         if (child.type !== "text" || child.content !== "") {
           childTokenTypes += tokenTypeMap[child.type] || "x";
         }
-      });
+      }
       if (linkOrImageOnlyLineRe.test(childTokenTypes)) {
         linkOnlyLineNumbers.push(token.lineNumber);
       }
@@ -83,7 +82,7 @@ module.exports = {
           (strict ||
            (!(stern && sternModeRe.test(line)) &&
             !includesSorted(linkOnlyLineNumbers, lineNumber) &&
-            !labelRe.test(line))) &&
+            !linkReferenceDefinitionRe.test(line))) &&
           lengthRe.test(line)) {
         addErrorDetailIf(
           onError,

package/lib/md014.js

@@ -11,7 +11,7 @@ module.exports = {
   "description": "Dollar signs used before commands without showing output",
   "tags": [ "code" ],
   "function": function MD014(params, onError) {
-    [ "code_block", "fence" ].forEach((type) => {
+    for (const type of [ "code_block", "fence" ]) {
       filterTokens(params, type, (token) => {
         const margin = (token.type === "fence") ? 1 : 0;
         const dollarInstances = [];
@@ -31,7 +31,7 @@ module.exports = {
           }
         }
         if (allDollars) {
-          dollarInstances.forEach((instance) => {
+          for (const instance of dollarInstances) {
             const [ i, lineTrim, column, length ] = instance;
             addErrorContext(
               onError,
@@ -45,9 +45,9 @@ module.exports = {
                 "deleteCount": length
               }
             );
-          });
+          }
         }
       });
-    });
+    }
   }
 };

package/lib/md021.js

@@ -5,6 +5,8 @@
 const { addErrorContext, filterTokens, headingStyleFor } =
   require("../helpers");
 
+const closedAtxRe = /^(#+)([ \t]+)([^ \t]|[^ \t].*[^ \t])([ \t]+)(#+)(\s*)$/;
+
 module.exports = {
   "names": [ "MD021", "no-multiple-space-closed-atx" ],
   "description": "Multiple spaces inside hashes on closed atx style heading",
@@ -13,7 +15,7 @@ module.exports = {
     filterTokens(params, "heading_open", (token) => {
       if (headingStyleFor(token) === "atx_closed") {
         const { line, lineNumber } = token;
-        const match = /^(#+)([ \t]+)([^#]+?)([ \t]+)(#+)(\s*)$/.exec(line);
+        const match = closedAtxRe.exec(line);
         if (match) {
           const [
             ,

package/lib/md026.js

@@ -20,7 +20,7 @@ module.exports = {
       new RegExp("\\s*[" + escapeForRegExp(punctuation) + "]+$");
     forEachHeading(params, (heading) => {
       const { line, lineNumber } = heading;
-      const trimmedLine = line.replace(/[\s#]*$/, "");
+      const trimmedLine = line.replace(/([^\s#])[\s#]+$/, "$1");
       const match = trailingPunctuationRe.exec(trimmedLine);
       if (match && !endOfLineHtmlEntityRe.test(trimmedLine)) {
         const fullMatch = match[0];

package/lib/md027.js

@@ -13,7 +13,7 @@ module.exports = {
   "function": function MD027(params, onError) {
     let blockquoteNesting = 0;
     let listItemNesting = 0;
-    params.tokens.forEach((token) => {
+    for (const token of params.tokens) {
       const { content, lineNumber, type } = token;
       if (type === "blockquote_open") {
         blockquoteNesting++;
@@ -51,6 +51,6 @@ module.exports = {
           }
         }
       }
-    });
+    }
   }
 };

package/lib/md028.js

@@ -11,7 +11,7 @@ module.exports = {
   "function": function MD028(params, onError) {
     let prevToken = {};
     let prevLineNumber = null;
-    params.tokens.forEach(function forToken(token) {
+    for (const token of params.tokens) {
       if ((token.type === "blockquote_open") &&
           (prevToken.type === "blockquote_close")) {
         for (
@@ -25,6 +25,6 @@ module.exports = {
       if (token.type === "blockquote_open") {
         prevLineNumber = token.map[1] + 1;
       }
-    });
+    }
   }
 };

package/lib/md029.js

@@ -18,7 +18,8 @@ module.exports = {
   "tags": [ "ol" ],
   "function": function MD029(params, onError) {
     const style = String(params.config.style || "one_or_ordered");
-    flattenedLists().filter((list) => !list.unordered).forEach((list) => {
+    const filteredLists = flattenedLists().filter((list) => !list.unordered);
+    for (const list of filteredLists) {
       const { items } = list;
       let current = 1;
       let incrementing = false;
@@ -49,7 +50,7 @@ module.exports = {
         current = 1;
       }
       // Validate each list item marker
-      items.forEach((item) => {
+      for (const item of items) {
         const match = orderedListItemMarkerRe.exec(item.line);
         if (match) {
           addErrorDetailIf(onError, item.lineNumber,
@@ -60,7 +61,7 @@ module.exports = {
             current++;
           }
         }
-      });
-    });
+      }
+    }
   }
 };

package/lib/md030.js

@@ -14,13 +14,13 @@ module.exports = {
     const olSingle = Number(params.config.ol_single || 1);
     const ulMulti = Number(params.config.ul_multi || 1);
     const olMulti = Number(params.config.ol_multi || 1);
-    flattenedLists().forEach((list) => {
+    for (const list of flattenedLists()) {
       const lineCount = list.lastLineIndex - list.open.map[0];
       const allSingle = lineCount === list.items.length;
       const expectedSpaces = list.unordered ?
         (allSingle ? ulSingle : ulMulti) :
         (allSingle ? olSingle : olMulti);
-      list.items.forEach((item) => {
+      for (const item of list.items) {
         const { line, lineNumber } = item;
         const match = /^[\s>]*\S+(\s*)/.exec(line);
         const [ { "length": matchLength }, { "length": actualSpaces } ] = match;
@@ -44,7 +44,7 @@ module.exports = {
             fixInfo
           );
         }
-      });
-    });
+      }
+    }
   }
 };

package/lib/md031.js

@@ -5,7 +5,7 @@
 const { addErrorContext, forEachLine, isBlankLine } = require("../helpers");
 const { lineMetadata } = require("./cache");
 
-const codeFencePrefixRe = /^(.*?)\s*[`~]/;
+const codeFencePrefixRe = /^(.*?)[`~]/;
 
 module.exports = {
   "names": [ "MD031", "blanks-around-fences" ],
@@ -24,7 +24,7 @@ module.exports = {
         const [ , prefix ] = line.match(codeFencePrefixRe) || [];
         const fixInfo = (prefix === undefined) ? null : {
           "lineNumber": i + (onTopFence ? 1 : 2),
-          "insertText": `${prefix}\n`
+          "insertText": `${prefix.replace(/[^>]/g, " ").trim()}\n`
         };
         addErrorContext(
           onError,

package/lib/md032.js

@@ -13,7 +13,8 @@ module.exports = {
   "tags": [ "bullet", "ul", "ol", "blank_lines" ],
   "function": function MD032(params, onError) {
     const { lines } = params;
-    flattenedLists().filter((list) => !list.nesting).forEach((list) => {
+    const filteredLists = flattenedLists().filter((list) => !list.nesting);
+    for (const list of filteredLists) {
       const firstIndex = list.open.map[0];
       if (!isBlankLine(lines[firstIndex - 1])) {
         const line = lines[firstIndex];
@@ -45,6 +46,6 @@ module.exports = {
             "insertText": `${quotePrefix}\n`
           });
       }
-    });
+    }
   }
 };

package/lib/md033.js

@@ -2,12 +2,12 @@
 
 "use strict";
 
-const { addError, forEachLine, unescapeMarkdown } = require("../helpers");
-const { lineMetadata } = require("./cache");
+const {
+  addError, forEachLine, htmlElementRe, withinAnyRange, unescapeMarkdown
+} = require("../helpers");
+const { codeBlockAndSpanRanges, lineMetadata } = require("./cache");
 
-const htmlElementRe = /<(([A-Za-z][A-Za-z0-9-]*)(?:\s[^>]*)?)\/?>/g;
 const linkDestinationRe = /]\(\s*$/;
-const inlineCodeRe = /^[^`]*(`+[^`]+`+[^`]+)*`+[^`]*$/;
 // See https://spec.commonmark.org/0.29/#autolinks
 const emailAddressRe =
   // eslint-disable-next-line max-len
@@ -21,19 +21,22 @@ module.exports = {
     let allowedElements = params.config.allowed_elements;
     allowedElements = Array.isArray(allowedElements) ? allowedElements : [];
     allowedElements = allowedElements.map((element) => element.toLowerCase());
+    const exclusions = codeBlockAndSpanRanges();
     forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
       let match = null;
       // eslint-disable-next-line no-unmodified-loop-condition
       while (!inCode && ((match = htmlElementRe.exec(line)) !== null)) {
         const [ tag, content, element ] = match;
-        if (!allowedElements.includes(element.toLowerCase()) &&
+        if (
+          !allowedElements.includes(element.toLowerCase()) &&
           !tag.endsWith("\\>") &&
-          !emailAddressRe.test(content)) {
+          !emailAddressRe.test(content) &&
+          !withinAnyRange(exclusions, lineIndex, match.index, match[0].length)
+        ) {
           const prefix = line.substring(0, match.index);
-          if (!linkDestinationRe.test(prefix) && !inlineCodeRe.test(prefix)) {
+          if (!linkDestinationRe.test(prefix)) {
             const unescaped = unescapeMarkdown(prefix + "<", "_");
-            if (!unescaped.endsWith("_") &&
-              ((unescaped + "`").match(/`/g).length % 2)) {
+            if (!unescaped.endsWith("_")) {
               addError(onError, lineIndex + 1, "Element: " + element,
                 null, [ match.index + 1, tag.length ]);
             }

package/lib/md034.js

@@ -11,7 +11,7 @@ module.exports = {
   "function": function MD034(params, onError) {
     filterTokens(params, "inline", (token) => {
       let inLink = false;
-      token.children.forEach((child) => {
+      for (const child of token.children) {
         const { content, line, lineNumber, type } = child;
         let match = null;
         if (type === "link_open") {
@@ -55,7 +55,7 @@ module.exports = {
             }
           }
         }
-      });
+      }
     });
   }
 };

package/lib/md035.js

@@ -9,13 +9,18 @@ module.exports = {
   "description": "Horizontal rule style",
   "tags": [ "hr" ],
   "function": function MD035(params, onError) {
-    let style = String(params.config.style || "consistent");
-    filterTokens(params, "hr", function forToken(token) {
-      const lineTrim = token.line.trim();
+    let style = String(params.config.style || "consistent").trim();
+    filterTokens(params, "hr", (token) => {
+      const { line, lineNumber } = token;
+      let { markup } = token;
+      const match = line.match(/[_*\-\s\t]+$/);
+      if (match) {
+        markup = match[0].trim();
+      }
       if (style === "consistent") {
-        style = lineTrim;
+        style = markup;
       }
-      addErrorDetailIf(onError, token.lineNumber, style, lineTrim);
+      addErrorDetailIf(onError, lineNumber, style, markup);
     });
   }
 };

package/lib/md036.js

@@ -49,8 +49,8 @@ module.exports = {
       return base;
     }
     let state = base;
-    params.tokens.forEach(function forToken(token) {
+    for (const token of params.tokens) {
       state = state(token);
-    });
+    }
   }
 };

package/lib/md037.js

@@ -7,6 +7,7 @@ const { addErrorContext, emphasisMarkersInContent, forEachLine, isBlankLine } =
 const { lineMetadata } = require("./cache");
 
 const emphasisRe = /(^|[^\\]|\\\\)(?:(\*\*?\*?)|(__?_?))/g;
+const embeddedUnderscoreRe = /([A-Za-z0-9])_([A-Za-z0-9])/g;
 const asteriskListItemMarkerRe = /^([\s>]*)\*(\s+)/;
 const leftSpaceRe = /^\s+/;
 const rightSpaceRe = /\s+$/;
@@ -98,14 +99,15 @@ module.exports = {
           // Emphasis has no meaning here
           return;
         }
+        let patchedLine = line.replace(embeddedUnderscoreRe, "$1 $2");
         if (onItemStart) {
           // Trim overlapping '*' list item marker
-          line = line.replace(asteriskListItemMarkerRe, "$1 $2");
+          patchedLine = patchedLine.replace(asteriskListItemMarkerRe, "$1 $2");
         }
         let match = null;
         // Match all emphasis-looking runs in the line...
-        while ((match = emphasisRe.exec(line))) {
-          const ignoreMarkersForLine = ignoreMarkersByLine[lineIndex] || [];
+        while ((match = emphasisRe.exec(patchedLine))) {
+          const ignoreMarkersForLine = ignoreMarkersByLine[lineIndex];
           const matchIndex = match.index + match[1].length;
           if (ignoreMarkersForLine.includes(matchIndex)) {
             // Ignore emphasis markers inside code spans and links

package/lib/md038.js

@@ -7,7 +7,11 @@ const { addErrorContext, filterTokens, forEachInlineCodeSpan, newLineRe } =
 
 const leftSpaceRe = /^\s([^`]|$)/;
 const rightSpaceRe = /[^`]\s$/;
-const singleLeftRightSpaceRe = /^\s(?:\S.*\S|\S)\s$/;
+
+const spaceInsideCodeInline = (token) => (
+  (token.type === "code_inline") &&
+  (leftSpaceRe.test(token.content) || rightSpaceRe.test(token.content))
+);
 
 module.exports = {
   "names": [ "MD038", "no-space-in-code" ],
@@ -15,7 +19,7 @@ module.exports = {
   "tags": [ "whitespace", "code" ],
   "function": function MD038(params, onError) {
     filterTokens(params, "inline", (token) => {
-      if (token.children.some((child) => child.type === "code_inline")) {
+      if (token.children.some(spaceInsideCodeInline)) {
         const tokenLines = params.lines.slice(token.map[0], token.map[1]);
         forEachInlineCodeSpan(
           tokenLines.join("\n"),
@@ -33,8 +37,7 @@ module.exports = {
               rangeLineOffset = codeLines.length - 1;
               fixIndex = 0;
             }
-            const allowed = singleLeftRightSpaceRe.test(code);
-            if ((left || right) && !allowed) {
+            if (left || right) {
               const codeLinesRange = codeLines[rangeLineOffset];
               if (codeLines.length > 1) {
                 rangeLength = codeLinesRange.length + tickCount;