markdownlint 0.26.1 → 0.27.0

package/lib/markdownlint.js

@@ -2,8 +2,8 @@
 
 "use strict";
 
-const path = require("path");
-const { promisify } = require("util");
+const path = require("node:path");
+const { promisify } = require("node:util");
 const markdownIt = require("markdown-it");
 const { deprecatedRuleNames } = require("./constants");
 const rules = require("./rules");
@@ -233,11 +233,6 @@ function annotateAndFreezeTokens(tokens, lines) {
     if (!token.map && trMap) {
       token.map = [ ...trMap ];
     }
-    // Adjust maps for math blocks
-    if (helpers.isMathBlock(token) && token.map[1]) {
-      // markdown-it-texmath plugin does not account for math_block_end
-      token.map[1]++;
-    }
     // Update token metadata
     if (token.map) {
       token.line = lines[token.map[0]];
@@ -879,7 +874,7 @@ function lintInput(options, synchronous, callback) {
     // @ts-ignore
     md.use(...plugin);
   }
-  const fs = options.fs || require("fs");
+  const fs = options.fs || require("node:fs");
   const results = newResults(ruleList);
   let done = false;
   let concurrency = 0;
@@ -1085,10 +1080,10 @@ function readConfig(file, parsers, fs, callback) {
     }
   }
   if (!fs) {
-    fs = require("fs");
+    fs = require("node:fs");
   }
   // Read file
-  const os = require("os");
+  const os = require("node:os");
   file = helpers.expandTildePath(file, os);
   fs.readFile(file, "utf8", (err, content) => {
     if (err) {
@@ -1160,10 +1155,10 @@ function readConfigPromise(file, parsers, fs) {
  */
 function readConfigSync(file, parsers, fs) {
   if (!fs) {
-    fs = require("fs");
+    fs = require("node:fs");
   }
   // Read file
-  const os = require("os");
+  const os = require("node:os");
   file = helpers.expandTildePath(file, os);
   const content = fs.readFileSync(file, "utf8");
   // Try to parse file

package/lib/md011.js

@@ -6,7 +6,7 @@ const { addError, forEachLine, withinAnyRange } = require("../helpers");
 const { codeBlockAndSpanRanges, lineMetadata } = require("./cache");
 
 const reversedLinkRe =
-  /(^|[^\\])\(([^)]+)\)\[([^\]^][^\]]*)](?!\()/g;
+  /(^|[^\\])\(([^()]+)\)\[([^\]^][^\]]*)\](?!\()/g;
 
 module.exports = {
   "names": [ "MD011", "no-reversed-links" ],
@@ -30,7 +30,7 @@ module.exports = {
               onError,
               lineIndex + 1,
               reversedLink.slice(preChar.length),
-              null,
+              undefined,
               [ index + 1, length ],
               {
                 "editColumn": index + 1,

package/lib/md013.js

@@ -3,14 +3,14 @@
 "use strict";
 
 const { addErrorDetailIf, filterTokens, forEachHeading, forEachLine,
-  includesSorted, linkReferenceDefinitionRe } = require("../helpers");
-const { lineMetadata } = require("./cache");
+  includesSorted } = require("../helpers");
+const { lineMetadata, referenceLinkImageData } = require("./cache");
 
 const longLineRePrefix = "^.{";
 const longLineRePostfixRelaxed = "}.*\\s.*$";
 const longLineRePostfixStrict = "}.+$";
-const linkOrImageOnlyLineRe = /^[es]*(lT?L|I)[ES]*$/;
-const sternModeRe = /^([#>\s]*\s)?\S*$/;
+const linkOrImageOnlyLineRe = /^[es]*(?:lT?L|I)[ES]*$/;
+const sternModeRe = /^(?:[#>\s]*\s)?\S*$/;
 const tokenTypeMap = {
   "em_open": "e",
   "em_close": "E",
@@ -67,6 +67,7 @@ module.exports = {
         linkOnlyLineNumbers.push(token.lineNumber);
       }
     });
+    const { definitionLineIndices } = referenceLinkImageData();
     forEachLine(lineMetadata(), (line, lineIndex, inCode, onFence, inTable) => {
       const lineNumber = lineIndex + 1;
       const isHeading = includesSorted(headingLineNumbers, lineNumber);
@@ -79,10 +80,10 @@ module.exports = {
       if ((includeCodeBlocks || !inCode) &&
           (includeTables || !inTable) &&
           (includeHeadings || !isHeading) &&
+          !includesSorted(definitionLineIndices, lineIndex) &&
           (strict ||
            (!(stern && sternModeRe.test(line)) &&
-            !includesSorted(linkOnlyLineNumbers, lineNumber) &&
-            !linkReferenceDefinitionRe.test(line))) &&
+            !includesSorted(linkOnlyLineNumbers, lineNumber))) &&
           lengthRe.test(line)) {
         addErrorDetailIf(
           onError,

package/lib/md019.js

@@ -13,7 +13,7 @@ module.exports = {
     filterTokens(params, "heading_open", (token) => {
       if (headingStyleFor(token) === "atx") {
         const { line, lineNumber } = token;
-        const match = /^(#+)([ \t]{2,})(?:\S)/.exec(line);
+        const match = /^(#+)([ \t]{2,})\S/.exec(line);
         if (match) {
           const [
             ,

package/lib/md022.js

@@ -2,7 +2,17 @@
 
 "use strict";
 
-const { addErrorDetailIf, filterTokens, isBlankLine } = require("../helpers");
+const { addErrorDetailIf, blockquotePrefixRe, filterTokens, isBlankLine } =
+  require("../helpers");
+
+const getBlockQuote = (str, count) => (
+  (str || "")
+    .match(blockquotePrefixRe)[0]
+    .trimEnd()
+    // eslint-disable-next-line unicorn/prefer-spread
+    .concat("\n")
+    .repeat(count)
+);
 
 module.exports = {
   "names": [ "MD022", "blanks-around-headings", "blanks-around-headers" ],
@@ -31,7 +41,8 @@ module.exports = {
         lines[topIndex].trim(),
         null,
         {
-          "insertText": "".padEnd(linesAbove - actualAbove, "\n")
+          "insertText":
+            getBlockQuote(lines[topIndex - 1], linesAbove - actualAbove)
         });
       let actualBelow = 0;
       for (let i = 0; i < linesBelow; i++) {
@@ -49,7 +60,8 @@ module.exports = {
         null,
         {
           "lineNumber": nextIndex + 1,
-          "insertText": "".padEnd(linesBelow - actualBelow, "\n")
+          "insertText":
+            getBlockQuote(lines[nextIndex], linesBelow - actualBelow)
         });
     });
   }

package/lib/md023.js

@@ -4,7 +4,7 @@
 
 const { addErrorContext, filterTokens } = require("../helpers");
 
-const spaceBeforeHeadingRe = /^((?:\s+)|(?:[>\s]+\s\s))[^>\s]/;
+const spaceBeforeHeadingRe = /^(\s+|[>\s]+\s\s)[^>\s]/;
 
 module.exports = {
   "names": [ "MD023", "heading-start-left", "header-start-left" ],

package/lib/md026.js

@@ -5,7 +5,7 @@
 const { addError, allPunctuationNoQuestion, escapeForRegExp, forEachHeading } =
   require("../helpers");
 
-const endOfLineHtmlEntityRe = /&#?[0-9a-zA-Z]+;$/;
+const endOfLineHtmlEntityRe = /&#?[\da-zA-Z]+;$/;
 
 module.exports = {
   "names": [ "MD026", "no-trailing-punctuation" ],

package/lib/md032.js

@@ -2,11 +2,10 @@
 
 "use strict";
 
-const { addErrorContext, isBlankLine } = require("../helpers");
+const { addErrorContext, blockquotePrefixRe, isBlankLine } =
+  require("../helpers");
 const { flattenedLists } = require("./cache");
 
-const quotePrefixRe = /^[>\s]*/;
-
 module.exports = {
   "names": [ "MD032", "blanks-around-lists" ],
   "description": "Lists should be surrounded by blank lines",
@@ -18,7 +17,7 @@ module.exports = {
       const firstIndex = list.open.map[0];
       if (!isBlankLine(lines[firstIndex - 1])) {
         const line = lines[firstIndex];
-        const quotePrefix = line.match(quotePrefixRe)[0].trimEnd();
+        const quotePrefix = line.match(blockquotePrefixRe)[0].trimEnd();
         addErrorContext(
           onError,
           firstIndex + 1,
@@ -33,7 +32,7 @@ module.exports = {
       const lastIndex = list.lastLineIndex - 1;
       if (!isBlankLine(lines[lastIndex + 1])) {
         const line = lines[lastIndex];
-        const quotePrefix = line.match(quotePrefixRe)[0].trimEnd();
+        const quotePrefix = line.match(blockquotePrefixRe)[0].trimEnd();
         addErrorContext(
           onError,
           lastIndex + 1,

package/lib/md033.js

@@ -5,13 +5,14 @@
 const {
   addError, forEachLine, htmlElementRe, withinAnyRange, unescapeMarkdown
 } = require("../helpers");
-const { codeBlockAndSpanRanges, lineMetadata } = require("./cache");
+const { codeBlockAndSpanRanges, lineMetadata, referenceLinkImageData } =
+  require("./cache");
 
-const linkDestinationRe = /]\(\s*$/;
+const linkDestinationRe = /\]\(\s*$/;
 // See https://spec.commonmark.org/0.29/#autolinks
 const emailAddressRe =
   // eslint-disable-next-line max-len
-  /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/;
+  /^[\w.!#$%&'*+/=?^`{|}~-]+@[a-zA-Z\d](?:[a-zA-Z\d-]{0,61}[a-zA-Z\d])?(?:\.[a-zA-Z\d](?:[a-zA-Z\d-]{0,61}[a-zA-Z\d])?)*$/;
 
 module.exports = {
   "names": [ "MD033", "no-inline-html" ],
@@ -22,6 +23,15 @@ module.exports = {
     allowedElements = Array.isArray(allowedElements) ? allowedElements : [];
     allowedElements = allowedElements.map((element) => element.toLowerCase());
     const exclusions = codeBlockAndSpanRanges();
+    const { references, definitionLineIndices } = referenceLinkImageData();
+    for (const datas of references.values()) {
+      for (const data of datas) {
+        const [ lineIndex, index, , textLength, labelLength ] = data;
+        if (labelLength > 0) {
+          exclusions.push([ lineIndex, index + 3 + textLength, labelLength ]);
+        }
+      }
+    }
     forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
       let match = null;
       // eslint-disable-next-line no-unmodified-loop-condition
@@ -31,14 +41,15 @@ module.exports = {
           !allowedElements.includes(element.toLowerCase()) &&
           !tag.endsWith("\\>") &&
           !emailAddressRe.test(content) &&
-          !withinAnyRange(exclusions, lineIndex, match.index, match[0].length)
+          !withinAnyRange(exclusions, lineIndex, match.index, tag.length) &&
+          !definitionLineIndices.includes(lineIndex)
         ) {
           const prefix = line.substring(0, match.index);
           if (!linkDestinationRe.test(prefix)) {
             const unescaped = unescapeMarkdown(prefix + "<", "_");
             if (!unescaped.endsWith("_")) {
               addError(onError, lineIndex + 1, "Element: " + element,
-                null, [ match.index + 1, tag.length ]);
+                undefined, [ match.index + 1, tag.length ]);
             }
           }
         }

package/lib/md034.js

@@ -2,60 +2,85 @@
 
 "use strict";
 
-const { addErrorContext, bareUrlRe, filterTokens } = require("../helpers");
+const { addErrorContext, filterTokens, funcExpExec, urlFe, withinAnyRange } =
+  require("../helpers");
+const { codeBlockAndSpanRanges, htmlElementRanges, referenceLinkImageData } =
+  require("./cache");
+
+const htmlLinkRe = /<a(?:\s[^>]*)?>[^<>]*<\/a\s*>/gi;
 
 module.exports = {
   "names": [ "MD034", "no-bare-urls" ],
   "description": "Bare URL used",
   "tags": [ "links", "url" ],
   "function": function MD034(params, onError) {
-    filterTokens(params, "inline", (token) => {
-      let inLink = false;
-      for (const child of token.children) {
-        const { content, line, lineNumber, type } = child;
+    const { lines } = params;
+    const codeExclusions = [
+      ...codeBlockAndSpanRanges(),
+      ...htmlElementRanges()
+    ];
+    filterTokens(params, "html_block", (token) => {
+      for (let i = token.map[0]; i < token.map[1]; i++) {
+        codeExclusions.push([ i, 0, lines[i].length ]);
+      }
+    });
+    const { definitionLineIndices } = referenceLinkImageData();
+    for (const [ lineIndex, line ] of lines.entries()) {
+      if (definitionLineIndices[0] === lineIndex) {
+        definitionLineIndices.shift();
+      } else {
         let match = null;
-        if (type === "link_open") {
-          inLink = true;
-        } else if (type === "link_close") {
-          inLink = false;
-        } else if ((type === "text") && !inLink) {
-          while ((match = bareUrlRe.exec(content)) !== null) {
-            const [ bareUrl ] = match;
-            const matchIndex = match.index;
-            const bareUrlLength = bareUrl.length;
-            // Allow "[https://example.com]" to avoid conflicts with
-            // MD011/no-reversed-links; allow quoting as another way
-            // of deliberately including a bare URL
-            const leftChar = content[matchIndex - 1];
-            const rightChar = content[matchIndex + bareUrlLength];
-            if (
-              !((leftChar === "[") && (rightChar === "]")) &&
-              !((leftChar === "\"") && (rightChar === "\"")) &&
-              !((leftChar === "'") && (rightChar === "'"))
-            ) {
-              const index = line.indexOf(content);
-              const range = (index === -1) ? null : [
-                index + matchIndex + 1,
-                bareUrlLength
-              ];
-              const fixInfo = range ? {
-                "editColumn": range[0],
-                "deleteCount": range[1],
-                "insertText": `<${bareUrl}>`
-              } : null;
-              addErrorContext(
-                onError,
-                lineNumber,
-                bareUrl,
-                null,
-                null,
-                range,
-                fixInfo
-              );
-            }
+        const lineExclusions = [];
+        while ((match = htmlLinkRe.exec(line)) !== null) {
+          lineExclusions.push([ lineIndex, match.index, match[0].length ]);
+        }
+        while ((match = funcExpExec(urlFe, line)) !== null) {
+          const [ bareUrl ] = match;
+          // @ts-ignore
+          const matchIndex = match.index;
+          const bareUrlLength = bareUrl.length;
+          const prefix = line.slice(0, matchIndex);
+          const postfix = line.slice(matchIndex + bareUrlLength);
+          if (
+            // Allow <...> to avoid reporting non-bare links
+            !(prefix.endsWith("<") && postfix.startsWith(">")) &&
+            // Allow >...</ to avoid reporting <code>...</code>
+            !(prefix.endsWith(">") && postfix.startsWith("</")) &&
+            // Allow "..." and '...' to allow quoting a bare link
+            !(prefix.endsWith("\"") && postfix.startsWith("\"")) &&
+            !(prefix.endsWith("'") && postfix.startsWith("'")) &&
+            // Allow ](... to avoid reporting Markdown-style links
+            !(/\]\(\s*$/.test(prefix)) &&
+            // Allow [...] to avoid MD011/no-reversed-links and nested links
+            !(/\[[^\]]*$/.test(prefix) && /^[^[]*\]/.test(postfix)) &&
+            !withinAnyRange(
+              lineExclusions, lineIndex, matchIndex, bareUrlLength
+            ) &&
+            !withinAnyRange(
+              codeExclusions, lineIndex, matchIndex, bareUrlLength
+            )
+          ) {
+            const range = [
+              matchIndex + 1,
+              bareUrlLength
+            ];
+            const fixInfo = {
+              "editColumn": range[0],
+              "deleteCount": range[1],
+              "insertText": `<${bareUrl}>`
+            };
+            addErrorContext(
+              onError,
+              lineIndex + 1,
+              bareUrl,
+              null,
+              null,
+              range,
+              fixInfo
+            );
           }
         }
       }
-    });
+    }
   }
 };

package/lib/md035.js

@@ -13,7 +13,7 @@ module.exports = {
     filterTokens(params, "hr", (token) => {
       const { line, lineNumber } = token;
       let { markup } = token;
-      const match = line.match(/[_*\-\s\t]+$/);
+      const match = line.match(/[_*\-\s]+$/);
       if (match) {
         markup = match[0].trim();
       }

package/lib/md037.js

@@ -2,12 +2,12 @@
 
 "use strict";
 
-const { addErrorContext, emphasisMarkersInContent, forEachLine, isBlankLine } =
-  require("../helpers");
-const { lineMetadata } = require("./cache");
+const { addErrorContext, emphasisMarkersInContent, forEachLine, isBlankLine,
+  withinAnyRange } = require("../helpers");
+const { htmlElementRanges, lineMetadata } = require("./cache");
 
-const emphasisRe = /(^|[^\\]|\\\\)(?:(\*\*?\*?)|(__?_?))/g;
-const embeddedUnderscoreRe = /([A-Za-z0-9])_([A-Za-z0-9])/g;
+const emphasisRe = /(^|[^\\]|\\\\)(?:(\*{1,3})|(_{1,3}))/g;
+const embeddedUnderscoreRe = /([A-Za-z\d])_([A-Za-z\d])/g;
 const asteriskListItemMarkerRe = /^([\s>]*)\*(\s+)/;
 const leftSpaceRe = /^\s+/;
 const rightSpaceRe = /\s+$/;
@@ -18,6 +18,7 @@ module.exports = {
   "description": "Spaces inside emphasis markers",
   "tags": [ "whitespace", "emphasis" ],
   "function": function MD037(params, onError) {
+    const exclusions = htmlElementRanges();
     // eslint-disable-next-line init-declarations
     let effectiveEmphasisLength, emphasisIndex, emphasisKind, emphasisLength,
       pendingError = null;
@@ -50,25 +51,27 @@ module.exports = {
         // Report the violation
         const contextStart = emphasisIndex - emphasisLength;
         const contextEnd = matchIndex + contextLength;
-        const context = line.substring(contextStart, contextEnd);
         const column = contextStart + 1;
         const length = contextEnd - contextStart;
-        const leftMarker = line.substring(contextStart, emphasisIndex);
-        const rightMarker = match ? (match[2] || match[3]) : "";
-        const fixedText = `${leftMarker}${content.trim()}${rightMarker}`;
-        return [
-          onError,
-          lineIndex + 1,
-          context,
-          leftSpace,
-          rightSpace,
-          [ column, length ],
-          {
-            "editColumn": column,
-            "deleteCount": length,
-            "insertText": fixedText
-          }
-        ];
+        if (!withinAnyRange(exclusions, lineIndex, column, length)) {
+          const context = line.substring(contextStart, contextEnd);
+          const leftMarker = line.substring(contextStart, emphasisIndex);
+          const rightMarker = match ? (match[2] || match[3]) : "";
+          const fixedText = `${leftMarker}${content.trim()}${rightMarker}`;
+          return [
+            onError,
+            lineIndex + 1,
+            context,
+            leftSpace,
+            rightSpace,
+            [ column, length ],
+            {
+              "editColumn": column,
+              "deleteCount": length,
+              "insertText": fixedText
+            }
+          ];
+        }
       }
       return null;
     }

package/lib/md038.js

@@ -5,7 +5,7 @@
 const { addErrorContext, filterTokens, forEachInlineCodeSpan, newLineRe } =
   require("../helpers");
 
-const leftSpaceRe = /^\s([^`]|$)/;
+const leftSpaceRe = /^\s(?:[^`]|$)/;
 const rightSpaceRe = /[^`]\s$/;
 
 const spaceInsideCodeInline = (token) => (

package/lib/md039.js

@@ -5,7 +5,7 @@
 const { addErrorContext, filterTokens } = require("../helpers");
 
 const spaceInLinkRe =
-  /\[(?:\s+(?:[^\]]*?)\s*|(?:[^\]]*?)\s+)](?=((?:\([^)]*\))|(?:\[[^\]]*\])))/;
+  /\[(?:\s[^\]]*|[^\]]*?\s)\](?=(\([^)]*\)|\[[^\]]*\]))/;
 
 module.exports = {
   "names": [ "MD039", "no-space-in-links" ],

package/lib/md040.js

@@ -2,16 +2,35 @@
 
 "use strict";
 
-const { addErrorContext, filterTokens } = require("../helpers");
+const { addError, addErrorContext, filterTokens } = require("../helpers");
 
 module.exports = {
   "names": [ "MD040", "fenced-code-language" ],
   "description": "Fenced code blocks should have a language specified",
   "tags": [ "code", "language" ],
   "function": function MD040(params, onError) {
+    let allowed = params.config.allowed_languages;
+    allowed = Array.isArray(allowed) ? allowed : [];
+    const languageOnly = !!params.config.language_only;
+
     filterTokens(params, "fence", function forToken(token) {
-      if (!token.info.trim()) {
+      const lang = token.info.trim().split(/\s+/u).shift();
+      if (lang === "") {
         addErrorContext(onError, token.lineNumber, token.line);
+      } else if ((allowed.length > 0) && !allowed.includes(lang)) {
+        addError(
+          onError,
+          token.lineNumber,
+          `"${lang}" is not allowed`
+        );
+      }
+
+      if (languageOnly && (token.info !== lang)) {
+        addError(
+          onError,
+          token.lineNumber,
+          `Info string contains more than language: "${token.info}"`
+        );
       }
     });
   }

package/lib/md043.js

@@ -11,6 +11,7 @@ module.exports = {
   "tags": [ "headings", "headers" ],
   "function": function MD043(params, onError) {
     const requiredHeadings = params.config.headings || params.config.headers;
+    const matchCase = params.config.match_case || false;
     if (Array.isArray(requiredHeadings)) {
       const levels = {};
       for (const level of [ 1, 2, 3, 4, 5, 6 ]) {
@@ -21,6 +22,7 @@ module.exports = {
       let hasError = false;
       let anyHeadings = false;
       const getExpected = () => requiredHeadings[i++] || "[None]";
+      const handleCase = (str) => (matchCase ? str : str.toLowerCase());
       forEachHeading(params, (heading, content) => {
         if (!hasError) {
           anyHeadings = true;
@@ -28,13 +30,13 @@ module.exports = {
           const expected = getExpected();
           if (expected === "*") {
             const nextExpected = getExpected();
-            if (nextExpected.toLowerCase() !== actual.toLowerCase()) {
+            if (handleCase(nextExpected) !== handleCase(actual)) {
               matchAny = true;
               i--;
             }
           } else if (expected === "+") {
             matchAny = true;
-          } else if (expected.toLowerCase() === actual.toLowerCase()) {
+          } else if (handleCase(expected) === handleCase(actual)) {
             matchAny = false;
           } else if (matchAny) {
             i--;

package/lib/md044.js

@@ -2,8 +2,8 @@
 
 "use strict";
 
-const { addErrorDetailIf, bareUrlRe, escapeForRegExp, forEachLine,
-  forEachLink, withinAnyRange, linkReferenceDefinitionRe } =
+const { addErrorDetailIf, escapeForRegExp, forEachLine, forEachLink,
+  funcExpExec, linkReferenceDefinitionRe, urlFe, withinAnyRange } =
   require("../helpers");
 const { codeBlockAndSpanRanges, htmlElementRanges, lineMetadata } =
   require("./cache");
@@ -28,7 +28,8 @@ module.exports = {
         exclusions.push([ lineIndex, 0, line.length ]);
       } else {
         let match = null;
-        while ((match = bareUrlRe.exec(line)) !== null) {
+        while ((match = funcExpExec(urlFe, line)) !== null) {
+          // @ts-ignore
           exclusions.push([ lineIndex, match.index, match[0].length ]);
         }
         forEachLink(line, (index, _, text, destination) => {