markdownlint 0.21.1 → 0.24.0

package/lib/md011.js

@@ -2,40 +2,44 @@
 
 "use strict";
 
-const { addError, forEachInlineChild, unescapeMarkdown } =
-  require("../helpers");
+const { addError, forEachLine, overlapsAnyRange } = require("../helpers");
+const { inlineCodeSpanRanges, lineMetadata } = require("./cache");
 
-const reversedLinkRe = /\(([^)]+)\)\[([^\]^][^\]]*)]/g;
+const reversedLinkRe =
+  /(^|[^\\])\(([^)]+)\)\[([^\]^][^\]]*)](?!\()/g;
 
 module.exports = {
   "names": [ "MD011", "no-reversed-links" ],
   "description": "Reversed link syntax",
   "tags": [ "links" ],
   "function": function MD011(params, onError) {
-    forEachInlineChild(params, "text", (token) => {
-      const { lineNumber, content } = token;
-      let match = null;
-      while ((match = reversedLinkRe.exec(content)) !== null) {
-        const [ reversedLink, linkText, linkDestination ] = match;
-        const line = params.lines[lineNumber - 1];
-        const column = unescapeMarkdown(line).indexOf(reversedLink) + 1;
-        const length = reversedLink.length;
-        const range = column ? [ column, length ] : null;
-        const fixInfo = column ?
-          {
-            "editColumn": column,
-            "deleteCount": length,
-            "insertText": `[${linkText}](${linkDestination})`
-          } :
-          null;
-        addError(
-          onError,
-          lineNumber,
-          reversedLink,
-          null,
-          range,
-          fixInfo
-        );
+    const exclusions = inlineCodeSpanRanges();
+    forEachLine(lineMetadata(), (line, lineIndex, inCode, onFence) => {
+      if (!inCode && !onFence) {
+        let match = null;
+        while ((match = reversedLinkRe.exec(line)) !== null) {
+          const [ reversedLink, preChar, linkText, linkDestination ] = match;
+          const index = match.index + preChar.length;
+          const length = match[0].length - preChar.length;
+          if (
+            !linkText.endsWith("\\") &&
+            !linkDestination.endsWith("\\") &&
+            !overlapsAnyRange(exclusions, lineIndex, index, length)
+          ) {
+            addError(
+              onError,
+              lineIndex + 1,
+              reversedLink.slice(preChar.length),
+              null,
+              [ index + 1, length ],
+              {
+                "editColumn": index + 1,
+                "deleteCount": length,
+                "insertText": `[${linkText}](${linkDestination})`
+              }
+            );
+          }
+        }
       }
     });
   }

package/lib/md018.js

@@ -12,7 +12,7 @@ module.exports = {
   "function": function MD018(params, onError) {
     forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
       if (!inCode &&
-        /^#+[^#\s]/.test(line) &&
+        /^#+[^# \t]/.test(line) &&
         !/#\s*$/.test(line) &&
         !line.startsWith("#️⃣")) {
         const hashCount = /^#+/.exec(line)[0].length;

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 = /^(#+)(\s{2,})(?:\S)/.exec(line);
+        const match = /^(#+)([ \t]{2,})(?:\S)/.exec(line);
         if (match) {
           const [
             ,

package/lib/md020.js

@@ -13,7 +13,7 @@ module.exports = {
     forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
       if (!inCode) {
         const match =
-          /^(#+)(\s*)([^#]*?[^#\\])(\s*)((?:\\#)?)(#+)(\s*)$/.exec(line);
+          /^(#+)([ \t]*)([^#]*?[^#\\])([ \t]*)((?:\\#)?)(#+)(\s*)$/.exec(line);
         if (match) {
           const [
             ,

package/lib/md021.js

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

package/lib/md023.js

@@ -17,7 +17,7 @@ module.exports = {
       if (match) {
         const [ prefixAndFirstChar, prefix ] = match;
         let deleteCount = prefix.length;
-        const prefixLengthNoSpace = prefix.trimRight().length;
+        const prefixLengthNoSpace = prefix.trimEnd().length;
         if (prefixLengthNoSpace) {
           deleteCount -= prefixLengthNoSpace - 1;
         }

package/lib/md025.js

@@ -7,7 +7,7 @@ const { addErrorContext, filterTokens, frontMatterHasTitle } =
 
 module.exports = {
   "names": [ "MD025", "single-title", "single-h1" ],
-  "description": "Multiple top level headings in the same document",
+  "description": "Multiple top-level headings in the same document",
   "tags": [ "headings", "headers" ],
   "function": function MD025(params, onError) {
     const level = Number(params.config.level || 1);

package/lib/md026.js

@@ -2,24 +2,27 @@
 
 "use strict";
 
-const { addError, allPunctuation, escapeForRegExp, forEachHeading } =
+const { addError, allPunctuationNoQuestion, escapeForRegExp, forEachHeading } =
   require("../helpers");
 
+const endOfLineHtmlEntityRe = /&#?[0-9a-zA-Z]+;$/;
+
 module.exports = {
   "names": [ "MD026", "no-trailing-punctuation" ],
   "description": "Trailing punctuation in heading",
   "tags": [ "headings", "headers" ],
   "function": function MD026(params, onError) {
     let punctuation = params.config.punctuation;
-    punctuation =
-      String((punctuation === undefined) ? allPunctuation : punctuation);
+    punctuation = String(
+      (punctuation === undefined) ? allPunctuationNoQuestion : punctuation
+    );
     const trailingPunctuationRe =
       new RegExp("\\s*[" + escapeForRegExp(punctuation) + "]+$");
     forEachHeading(params, (heading) => {
       const { line, lineNumber } = heading;
       const trimmedLine = line.replace(/[\s#]*$/, "");
       const match = trailingPunctuationRe.exec(trimmedLine);
-      if (match) {
+      if (match && !endOfLineHtmlEntityRe.test(trimmedLine)) {
         const fullMatch = match[0];
         const column = match.index + 1;
         const length = fullMatch.length;

package/lib/md028.js

@@ -18,15 +18,7 @@ module.exports = {
           let lineNumber = prevLineNumber;
           lineNumber < token.lineNumber;
           lineNumber++) {
-          addError(
-            onError,
-            lineNumber,
-            null,
-            null,
-            null,
-            {
-              "deleteCount": -1
-            });
+          addError(onError, lineNumber);
         }
       }
       prevToken = token;

package/lib/md032.js

@@ -17,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].trimRight();
+        const quotePrefix = line.match(quotePrefixRe)[0].trimEnd();
         addErrorContext(
           onError,
           firstIndex + 1,
@@ -32,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].trimRight();
+        const quotePrefix = line.match(quotePrefixRe)[0].trimEnd();
         addErrorContext(
           onError,
           lastIndex + 1,

package/lib/md037.js

@@ -10,6 +10,7 @@ const emphasisRe = /(^|[^\\]|\\\\)(?:(\*\*?\*?)|(__?_?))/g;
 const asteriskListItemMarkerRe = /^([\s>]*)\*(\s+)/;
 const leftSpaceRe = /^\s+/;
 const rightSpaceRe = /\s+$/;
+const tablePipeRe = /\|/;
 
 module.exports = {
   "names": [ "MD037", "no-space-in-emphasis" ],
@@ -28,18 +29,23 @@ module.exports = {
       pendingError = null;
     }
     // eslint-disable-next-line jsdoc/require-jsdoc
-    function handleRunEnd(line, lineIndex, contextLength, match, matchIndex) {
+    function handleRunEnd(
+      line, lineIndex, contextLength, match, matchIndex, inTable
+    ) {
       // Close current run
       let content = line.substring(emphasisIndex, matchIndex);
       if (!emphasisLength) {
-        content = content.trimLeft();
+        content = content.trimStart();
       }
       if (!match) {
-        content = content.trimRight();
+        content = content.trimEnd();
       }
       const leftSpace = leftSpaceRe.test(content);
       const rightSpace = rightSpaceRe.test(content);
-      if (leftSpace || rightSpace) {
+      if (
+        (leftSpace || rightSpace) &&
+        (!inTable || !tablePipeRe.test(content))
+      ) {
         // Report the violation
         const contextStart = emphasisIndex - emphasisLength;
         const contextEnd = matchIndex + contextLength;
@@ -70,13 +76,25 @@ module.exports = {
     resetRunTracking();
     forEachLine(
       lineMetadata(),
-      (line, lineIndex, inCode, onFence, inTable, inItem, onBreak) => {
+      (line, lineIndex, inCode, onFence, inTable, inItem, onBreak, inMath) => {
         const onItemStart = (inItem === 1);
-        if (inCode || inTable || onBreak || onItemStart || isBlankLine(line)) {
+        if (
+          inCode ||
+          onFence ||
+          inTable ||
+          onBreak ||
+          onItemStart ||
+          isBlankLine(line)
+        ) {
           // Emphasis resets when leaving a block
           resetRunTracking();
         }
-        if (inCode || onBreak) {
+        if (
+          inCode ||
+          onFence ||
+          onBreak ||
+          inMath
+        ) {
           // Emphasis has no meaning here
           return;
         }
@@ -106,12 +124,20 @@ module.exports = {
             if (matchLength === effectiveEmphasisLength) {
               // Ending an existing run, report any pending error
               if (pendingError) {
+                // @ts-ignore
                 addErrorContext(...pendingError);
                 pendingError = null;
               }
               const error = handleRunEnd(
-                line, lineIndex, effectiveEmphasisLength, match, matchIndex);
+                line,
+                lineIndex,
+                effectiveEmphasisLength,
+                match,
+                matchIndex,
+                inTable
+              );
               if (error) {
+                // @ts-ignore
                 addErrorContext(...error);
               }
               // Reset
@@ -139,7 +165,7 @@ module.exports = {
         }
         if (emphasisIndex !== -1) {
           pendingError = pendingError ||
-            handleRunEnd(line, lineIndex, 0, null, line.length);
+            handleRunEnd(line, lineIndex, 0, null, line.length, inTable);
           // Adjust for pending run on new line
           emphasisIndex = 0;
           emphasisLength = 0;

package/lib/md039.js

@@ -24,8 +24,8 @@ module.exports = {
           linkText = "";
         } else if (type === "link_close") {
           inLink = false;
-          const left = linkText.trimLeft().length !== linkText.length;
-          const right = linkText.trimRight().length !== linkText.length;
+          const left = linkText.trimStart().length !== linkText.length;
+          const right = linkText.trimEnd().length !== linkText.length;
           if (left || right) {
             const line = params.lines[lineNumber - 1];
             let range = null;

package/lib/md041.js

@@ -6,7 +6,7 @@ const { addErrorContext, frontMatterHasTitle } = require("../helpers");
 
 module.exports = {
   "names": [ "MD041", "first-line-heading", "first-line-h1" ],
-  "description": "First line in file should be a top level heading",
+  "description": "First line in a file should be a top-level heading",
   "tags": [ "headings", "headers" ],
   "function": function MD041(params, onError) {
     const level = Number(params.config.level || 1);
@@ -17,11 +17,22 @@ module.exports = {
         params.config.front_matter_title
       );
     if (!foundFrontMatterTitle) {
+      const htmlHeadingRe = new RegExp(`^<h${level}[ />]`, "i");
       params.tokens.every((token) => {
+        let isError = false;
         if (token.type === "html_block") {
-          return true;
+          if (token.content.startsWith("<!--")) {
+            // Ignore leading HTML comments
+            return true;
+          } else if (!htmlHeadingRe.test(token.content)) {
+            // Something other than an HTML heading
+            isError = true;
+          }
+        } else if ((token.type !== "heading_open") || (token.tag !== tag)) {
+          // Something other than a Markdown heading
+          isError = true;
         }
-        if ((token.type !== "heading_open") || (token.tag !== tag)) {
+        if (isError) {
           addErrorContext(onError, token.lineNumber, token.line);
         }
         return false;

package/lib/md043.js

@@ -13,30 +13,46 @@ module.exports = {
     const requiredHeadings = params.config.headings || params.config.headers;
     if (Array.isArray(requiredHeadings)) {
       const levels = {};
-      [ 1, 2, 3, 4, 5, 6 ].forEach(function forLevel(level) {
+      [ 1, 2, 3, 4, 5, 6 ].forEach((level) => {
         levels["h" + level] = "######".substr(-level);
       });
       let i = 0;
-      let optional = false;
-      let errorCount = 0;
-      forEachHeading(params, function forHeading(heading, content) {
-        if (!errorCount) {
+      let matchAny = false;
+      let hasError = false;
+      let anyHeadings = false;
+      // eslint-disable-next-line func-style
+      const getExpected = () => requiredHeadings[i++] || "[None]";
+      forEachHeading(params, (heading, content) => {
+        if (!hasError) {
+          anyHeadings = true;
           const actual = levels[heading.tag] + " " + content;
-          const expected = requiredHeadings[i++] || "[None]";
+          const expected = getExpected();
           if (expected === "*") {
-            optional = true;
+            const nextExpected = getExpected();
+            if (nextExpected.toLowerCase() !== actual.toLowerCase()) {
+              matchAny = true;
+              i--;
+            }
+          } else if (expected === "+") {
+            matchAny = true;
           } else if (expected.toLowerCase() === actual.toLowerCase()) {
-            optional = false;
-          } else if (optional) {
+            matchAny = false;
+          } else if (matchAny) {
             i--;
           } else {
             addErrorDetailIf(onError, heading.lineNumber,
               expected, actual);
-            errorCount++;
+            hasError = true;
           }
         }
       });
-      if ((i < requiredHeadings.length) && !errorCount) {
+      const extraHeadings = requiredHeadings.length - i;
+      if (
+        !hasError &&
+        ((extraHeadings > 1) ||
+          ((extraHeadings === 1) && (requiredHeadings[i] !== "*"))) &&
+        (anyHeadings || !requiredHeadings.every((heading) => heading === "*"))
+      ) {
         addErrorContext(onError, params.lines.length,
           requiredHeadings[i]);
       }

package/lib/md044.js

@@ -2,11 +2,9 @@
 
 "use strict";
 
-const { addErrorDetailIf, bareUrlRe, escapeForRegExp, filterTokens,
-  forEachInlineChild, newLineRe } = require("../helpers");
-
-const startNonWordRe = /^\W/;
-const endNonWordRe = /\W$/;
+const { addErrorDetailIf, bareUrlRe, escapeForRegExp, forEachLine,
+  overlapsAnyRange, linkRe, linkReferenceRe } = require("../helpers");
+const { inlineCodeSpanRanges, lineMetadata } = require("./cache");
 
 module.exports = {
   "names": [ "MD044", "proper-names" ],
@@ -15,80 +13,65 @@ module.exports = {
   "function": function MD044(params, onError) {
     let names = params.config.names;
     names = Array.isArray(names) ? names : [];
+    names.sort((a, b) => (b.length - a.length) || a.localeCompare(b));
     const codeBlocks = params.config.code_blocks;
     const includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
-    // Text of automatic hyperlinks is implicitly a URL
-    const autolinkText = new Set();
-    filterTokens(params, "inline", (token) => {
-      let inAutoLink = false;
-      token.children.forEach((child) => {
-        const { info, type } = child;
-        if ((type === "link_open") && (info === "auto")) {
-          inAutoLink = true;
-        } else if (type === "link_close") {
-          inAutoLink = false;
-        } else if ((type === "text") && inAutoLink) {
-          autolinkText.add(child);
+    const exclusions = [];
+    forEachLine(lineMetadata(), (line, lineIndex) => {
+      if (linkReferenceRe.test(line)) {
+        exclusions.push([ lineIndex, 0, line.length ]);
+      } else {
+        let match = null;
+        while ((match = bareUrlRe.exec(line)) !== null) {
+          exclusions.push([ lineIndex, match.index, match[0].length ]);
         }
-      });
+        while ((match = linkRe.exec(line)) !== null) {
+          const [ , text, destination ] = match;
+          if (destination) {
+            exclusions.push(
+              [ lineIndex, match.index + text.length, destination.length ]
+            );
+          }
+        }
+      }
     });
-    // For each proper name...
-    names.forEach((name) => {
+    if (!includeCodeBlocks) {
+      exclusions.push(...inlineCodeSpanRanges());
+    }
+    for (const name of names) {
       const escapedName = escapeForRegExp(name);
-      const startNamePattern = startNonWordRe.test(name) ? "" : "\\S*\\b";
-      const endNamePattern = endNonWordRe.test(name) ? "" : "\\b\\S*";
+      const startNamePattern = /^\W/.test(name) ? "" : "\\b_*";
+      const endNamePattern = /\W$/.test(name) ? "" : "_*\\b";
       const namePattern =
-        `(${startNamePattern})(${escapedName})(${endNamePattern})`;
-      const anyNameRe = new RegExp(namePattern, "gi");
-      // eslint-disable-next-line jsdoc/require-jsdoc
-      function forToken(token) {
-        if (!autolinkText.has(token)) {
-          const fenceOffset = (token.type === "fence") ? 1 : 0;
-          token.content.split(newLineRe).forEach((line, index) => {
-            let match = null;
-            while ((match = anyNameRe.exec(line)) !== null) {
-              const [ fullMatch, leftMatch, nameMatch, rightMatch ] = match;
-              if (fullMatch.search(bareUrlRe) === -1) {
-                const wordMatch = fullMatch
-                  .replace(new RegExp(`^\\W{0,${leftMatch.length}}`), "")
-                  .replace(new RegExp(`\\W{0,${rightMatch.length}}$`), "");
-                if (!names.includes(wordMatch)) {
-                  const lineNumber = token.lineNumber + index + fenceOffset;
-                  const fullLine = params.lines[lineNumber - 1];
-                  const matchLength = wordMatch.length;
-                  const matchIndex = fullLine.indexOf(wordMatch);
-                  const range = (matchIndex === -1) ?
-                    null :
-                    [ matchIndex + 1, matchLength ];
-                  const fixInfo = (matchIndex === -1) ?
-                    null :
-                    {
-                      "editColumn": matchIndex + 1,
-                      "deleteCount": matchLength,
-                      "insertText": name
-                    };
-                  addErrorDetailIf(
-                    onError,
-                    lineNumber,
-                    name,
-                    nameMatch,
-                    null,
-                    null,
-                    range,
-                    fixInfo
-                  );
+        `(${startNamePattern})(${escapedName})${endNamePattern}`;
+      const nameRe = new RegExp(namePattern, "gi");
+      forEachLine(lineMetadata(), (line, lineIndex, inCode, onFence) => {
+        if (includeCodeBlocks || (!inCode && !onFence)) {
+          let match = null;
+          while ((match = nameRe.exec(line)) !== null) {
+            const [ , leftMatch, nameMatch ] = match;
+            const index = match.index + leftMatch.length;
+            const length = nameMatch.length;
+            if (!overlapsAnyRange(exclusions, lineIndex, index, length)) {
+              addErrorDetailIf(
+                onError,
+                lineIndex + 1,
+                name,
+                nameMatch,
+                null,
+                null,
+                [ index + 1, length ],
+                {
+                  "editColumn": index + 1,
+                  "deleteCount": length,
+                  "insertText": name
                 }
-              }
+              );
             }
-          });
+            exclusions.push([ lineIndex, index, length ]);
+          }
         }
-      }
-      forEachInlineChild(params, "text", forToken);
-      if (includeCodeBlocks) {
-        forEachInlineChild(params, "code_inline", forToken);
-        filterTokens(params, "code_block", forToken);
-        filterTokens(params, "fence", forToken);
-      }
-    });
+      });
+    }
   }
 };

package/lib/rules.js

@@ -54,7 +54,8 @@ const rules = [
 ];
 rules.forEach((rule) => {
   const name = rule.names[0].toLowerCase();
-  rule.information =
+  // eslint-disable-next-line dot-notation
+  rule["information"] =
     new URL(`${homepage}/blob/v${version}/doc/Rules.md#${name}`);
 });
 module.exports = rules;