markdownlint 0.28.2 → 0.30.0

package/lib/md032.js

@@ -4,46 +4,72 @@
 
 const { addErrorContext, blockquotePrefixRe, isBlankLine } =
   require("../helpers");
-const { flattenedLists } = require("./cache");
+const { filterByPredicate, flattenedChildren } =
+  require("../helpers/micromark.cjs");
+
+const nonContentTokens = new Set([
+  "blockQuoteMarker",
+  "blockQuotePrefix",
+  "blockQuotePrefixWhitespace",
+  "lineEnding",
+  "lineEndingBlank",
+  "linePrefix",
+  "listItemIndent"
+]);
+const isList = (token) => (
+  (token.type === "listOrdered") || (token.type === "listUnordered")
+);
+const addBlankLineError = (onError, lines, lineIndex, lineNumber) => {
+  const line = lines[lineIndex];
+  const quotePrefix = line.match(blockquotePrefixRe)[0].trimEnd();
+  addErrorContext(
+    onError,
+    lineIndex + 1,
+    line.trim(),
+    null,
+    null,
+    null,
+    {
+      lineNumber,
+      "insertText": `${quotePrefix}\n`
+    }
+  );
+};
 
 module.exports = {
   "names": [ "MD032", "blanks-around-lists" ],
   "description": "Lists should be surrounded by blank lines",
   "tags": [ "bullet", "ul", "ol", "blank_lines" ],
   "function": function MD032(params, onError) {
-    const { lines } = params;
-    const filteredLists = flattenedLists().filter((list) => !list.nesting);
-    for (const list of filteredLists) {
-      const firstIndex = list.open.map[0];
+    const { lines, parsers } = params;
+
+    // For every top-level list...
+    const topLevelLists = filterByPredicate(
+      parsers.micromark.tokens,
+      isList,
+      (token) => (isList(token) ? [] : token.children)
+    );
+    for (const list of topLevelLists) {
+
+      // Look for a blank line above the list
+      const firstIndex = list.startLine - 1;
       if (!isBlankLine(lines[firstIndex - 1])) {
-        const line = lines[firstIndex];
-        const quotePrefix = line.match(blockquotePrefixRe)[0].trimEnd();
-        addErrorContext(
-          onError,
-          firstIndex + 1,
-          line.trim(),
-          null,
-          null,
-          null,
-          {
-            "insertText": `${quotePrefix}\n`
-          });
+        addBlankLineError(onError, lines, firstIndex);
+      }
+
+      // Find the "visual" end of the list
+      let endLine = list.endLine;
+      for (const child of flattenedChildren(list).reverse()) {
+        if (!nonContentTokens.has(child.type)) {
+          endLine = child.endLine;
+          break;
+        }
       }
-      const lastIndex = list.lastLineIndex - 1;
+
+      // Look for a blank line below the list
+      const lastIndex = endLine - 1;
       if (!isBlankLine(lines[lastIndex + 1])) {
-        const line = lines[lastIndex];
-        const quotePrefix = line.match(blockquotePrefixRe)[0].trimEnd();
-        addErrorContext(
-          onError,
-          lastIndex + 1,
-          line.trim(),
-          null,
-          null,
-          null,
-          {
-            "lineNumber": lastIndex + 2,
-            "insertText": `${quotePrefix}\n`
-          });
+        addBlankLineError(onError, lines, lastIndex, lastIndex + 2);
       }
     }
   }

package/lib/md033.js

@@ -3,7 +3,7 @@
 "use strict";
 
 const { addError } = require("../helpers");
-const { filterByTypes, getHtmlTagInfo, parse } =
+const { filterByHtmlTokens, getHtmlTagInfo } =
   require("../helpers/micromark.cjs");
 
 const nextLinesRe = /[\r\n][\s\S]*$/;
@@ -16,50 +16,24 @@ module.exports = {
     let allowedElements = params.config.allowed_elements;
     allowedElements = Array.isArray(allowedElements) ? allowedElements : [];
     allowedElements = allowedElements.map((element) => element.toLowerCase());
-    const pending = [ [ 0, params.parsers.micromark.tokens ] ];
-    let current = null;
-    while ((current = pending.shift())) {
-      const [ offset, tokens ] = current;
-      for (const token of filterByTypes(tokens, [ "htmlFlow", "htmlText" ])) {
-        if (token.type === "htmlText") {
-          const htmlTagInfo = getHtmlTagInfo(token);
-          if (
-            htmlTagInfo &&
-            !htmlTagInfo.close &&
-            !allowedElements.includes(htmlTagInfo.name.toLowerCase())
-          ) {
-            const range = [
-              token.startColumn,
-              token.text.replace(nextLinesRe, "").length
-            ];
-            addError(
-              onError,
-              token.startLine + offset,
-              "Element: " + htmlTagInfo.name,
-              undefined,
-              range
-            );
-          }
-        } else {
-          // token.type === "htmlFlow"
-          // Re-parse without "htmlFlow" to get only "htmlText" tokens
-          const options = {
-            "extensions": [
-              {
-                "disable": {
-                  "null": [ "codeIndented", "htmlFlow" ]
-                }
-              }
-            ]
-          };
-          // Use lines instead of token.text for accurate columns
-          const lines =
-            params.lines.slice(token.startLine - 1, token.endLine).join("\n");
-          const flowTokens = parse(lines, options);
-          pending.push(
-            [ token.startLine - 1, flowTokens ]
-          );
-        }
+    for (const token of filterByHtmlTokens(params.parsers.micromark.tokens)) {
+      const htmlTagInfo = getHtmlTagInfo(token);
+      if (
+        htmlTagInfo &&
+        !htmlTagInfo.close &&
+        !allowedElements.includes(htmlTagInfo.name.toLowerCase())
+      ) {
+        const range = [
+          token.startColumn,
+          token.text.replace(nextLinesRe, "").length
+        ];
+        addError(
+          onError,
+          token.startLine,
+          "Element: " + htmlTagInfo.name,
+          undefined,
+          range
+        );
       }
     }
   }

package/lib/md034.js

@@ -3,7 +3,7 @@
 "use strict";
 
 const { addErrorContext } = require("../helpers");
-const { filterByPredicate, getHtmlTagInfo } =
+const { filterByPredicate, getHtmlTagInfo, parse } =
   require("../helpers/micromark.cjs");
 
 module.exports = {
@@ -11,9 +11,9 @@ module.exports = {
   "description": "Bare URL used",
   "tags": [ "links", "url" ],
   "function": function MD034(params, onError) {
-    const literalAutolinks =
+    const literalAutolinks = (tokens) => (
       filterByPredicate(
-        params.parsers.micromark.tokens,
+        tokens,
         (token) => token.type === "literalAutolink",
         (token) => {
           const { children } = token;
@@ -43,26 +43,33 @@ module.exports = {
             }
           }
           return result;
-        });
-    for (const token of literalAutolinks) {
-      const range = [
-        token.startColumn,
-        token.endColumn - token.startColumn
-      ];
-      const fixInfo = {
-        "editColumn": range[0],
-        "deleteCount": range[1],
-        "insertText": `<${token.text}>`
-      };
-      addErrorContext(
-        onError,
-        token.startLine,
-        token.text,
-        null,
-        null,
-        range,
-        fixInfo
-      );
+        }
+      )
+    );
+    if (literalAutolinks(params.parsers.micromark.tokens).length > 0) {
+      // Re-parse with correct link/image reference definition handling
+      const document = params.lines.join("\n");
+      const tokens = parse(document, undefined, false);
+      for (const token of literalAutolinks(tokens)) {
+        const range = [
+          token.startColumn,
+          token.endColumn - token.startColumn
+        ];
+        const fixInfo = {
+          "editColumn": range[0],
+          "deleteCount": range[1],
+          "insertText": `<${token.text}>`
+        };
+        addErrorContext(
+          onError,
+          token.startLine,
+          token.text,
+          null,
+          null,
+          range,
+          fixInfo
+        );
+      }
     }
   }
 };

package/lib/md037.js

@@ -2,180 +2,97 @@
 
 "use strict";
 
-const { addErrorContext, emphasisMarkersInContent, forEachLine, isBlankLine,
-  withinAnyRange } = require("../helpers");
-const { htmlElementRanges, lineMetadata } = require("./cache");
+const { addError } = require("../helpers");
 
-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+$/;
-const tablePipeRe = /\|/;
+const emphasisStartTextRe = /^(\S{1,3})(\s+)\S/;
+const emphasisEndTextRe = /\S(\s+)(\S{1,3})$/;
 
 module.exports = {
   "names": [ "MD037", "no-space-in-emphasis" ],
   "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;
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    function resetRunTracking() {
-      emphasisIndex = -1;
-      emphasisLength = 0;
-      emphasisKind = "";
-      effectiveEmphasisLength = 0;
-      pendingError = null;
+
+    // Initialize variables
+    const { lines, parsers } = params;
+    const emphasisTokensByMarker = new Map();
+    for (const marker of [ "_", "__", "___", "*", "**", "***" ]) {
+      emphasisTokensByMarker.set(marker, []);
     }
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    function handleRunEnd(
-      line, lineIndex, contextLength, match, matchIndex, inTable
-    ) {
-      // Close current run
-      let content = line.substring(emphasisIndex, matchIndex);
-      if (!emphasisLength) {
-        content = content.trimStart();
+    const pending = [ ...parsers.micromark.tokens ];
+    let token = null;
+    while ((token = pending.shift())) {
+
+      // Use reparsed children of htmlFlow tokens
+      if (token.type === "htmlFlow") {
+        pending.unshift(...token.htmlFlowChildren);
+        continue;
       }
-      if (!match) {
-        content = content.trimEnd();
+      pending.push(...token.children);
+
+      // Build lists of bare tokens for each emphasis marker type
+      for (const emphasisTokens of emphasisTokensByMarker.values()) {
+        emphasisTokens.length = 0;
       }
-      const leftSpace = leftSpaceRe.test(content);
-      const rightSpace = rightSpaceRe.test(content);
-      if (
-        (leftSpace || rightSpace) &&
-        (!inTable || !tablePipeRe.test(content))
-      ) {
-        // Report the violation
-        const contextStart = emphasisIndex - emphasisLength;
-        const contextEnd = matchIndex + contextLength;
-        const column = contextStart + 1;
-        const length = contextEnd - contextStart;
-        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
-            }
-          ];
+      for (const child of token.children) {
+        const { text, type } = child;
+        if ((type === "data") && (text.length <= 3)) {
+          const emphasisTokens = emphasisTokensByMarker.get(text);
+          if (emphasisTokens) {
+            emphasisTokens.push(child);
+          }
         }
       }
-      return null;
-    }
-    // Initialize
-    const ignoreMarkersByLine = emphasisMarkersInContent(params);
-    resetRunTracking();
-    forEachLine(
-      lineMetadata(),
-      (line, lineIndex, inCode, onFence, inTable, inItem, onBreak, inMath) => {
-        const onItemStart = (inItem === 1);
-        if (
-          inCode ||
-          onFence ||
-          inTable ||
-          onBreak ||
-          onItemStart ||
-          isBlankLine(line)
-        ) {
-          // Emphasis resets when leaving a block
-          resetRunTracking();
-        }
-        if (
-          inCode ||
-          onFence ||
-          onBreak ||
-          inMath
-        ) {
-          // Emphasis has no meaning here
-          return;
-        }
-        let patchedLine = line.replace(embeddedUnderscoreRe, "$1 $2");
-        if (onItemStart) {
-          // Trim overlapping '*' list item marker
-          patchedLine = patchedLine.replace(asteriskListItemMarkerRe, "$1 $2");
-        }
-        let match = null;
-        // Match all emphasis-looking runs in the line...
-        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
-            continue;
-          }
-          const matchLength = match[0].length - match[1].length;
-          const matchKind = (match[2] || match[3])[0];
-          if (emphasisIndex === -1) {
-            // New run
-            emphasisIndex = matchIndex + matchLength;
-            emphasisLength = matchLength;
-            emphasisKind = matchKind;
-            effectiveEmphasisLength = matchLength;
-          } else if (matchKind === emphasisKind) {
-            // Matching emphasis markers
-            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,
-                inTable
+
+      // Process bare tokens for each emphasis marker type
+      for (const emphasisTokens of emphasisTokensByMarker.values()) {
+        for (let i = 0; i + 1 < emphasisTokens.length; i += 2) {
+
+          // Process start token of start/end pair
+          const startToken = emphasisTokens[i];
+          const startText =
+            lines[startToken.startLine - 1].slice(startToken.startColumn - 1);
+          const startMatch = startText.match(emphasisStartTextRe);
+          if (startMatch) {
+            const [ startContext, startMarker, startSpaces ] = startMatch;
+            if ((startMarker === startToken.text) && (startSpaces.length > 0)) {
+              addError(
+                onError,
+                startToken.startLine,
+                undefined,
+                startContext,
+                [ startToken.startColumn, startContext.length ],
+                {
+                  "editColumn": startToken.endColumn,
+                  "deleteCount": startSpaces.length
+                }
               );
-              if (error) {
-                // @ts-ignore
-                addErrorContext(...error);
-              }
-              // Reset
-              resetRunTracking();
-            } else if (matchLength === 3) {
-              // Swap internal run length (1->2 or 2->1)
-              effectiveEmphasisLength = matchLength - effectiveEmphasisLength;
-            } else if (effectiveEmphasisLength === 3) {
-              // Downgrade internal run (3->1 or 3->2)
-              effectiveEmphasisLength -= matchLength;
-            } else {
-              // Upgrade to internal run (1->3 or 2->3)
-              effectiveEmphasisLength += matchLength;
             }
-            // Back up one character so RegExp has a chance to match the
-            // next marker (ex: "**star**_underscore_")
-            if (emphasisRe.lastIndex > 1) {
-              emphasisRe.lastIndex--;
+          }
+
+          // Process end token of start/end pair
+          const endToken = emphasisTokens[i + 1];
+          const endText =
+            lines[endToken.startLine - 1].slice(0, endToken.endColumn - 1);
+          const endMatch = endText.match(emphasisEndTextRe);
+          if (endMatch) {
+            const [ endContext, endSpace, endMarker ] = endMatch;
+            if ((endMarker === endToken.text) && (endSpace.length > 0)) {
+              addError(
+                onError,
+                endToken.startLine,
+                undefined,
+                endContext,
+                [ endToken.endColumn - endContext.length, endContext.length ],
+                {
+                  "editColumn": endToken.startColumn - endSpace.length,
+                  "deleteCount": endSpace.length
+                }
+              );
             }
-          } else if (emphasisRe.lastIndex > 1) {
-            // Back up one character so RegExp has a chance to match the
-            // mis-matched marker (ex: "*text_*")
-            emphasisRe.lastIndex--;
           }
         }
-        if (emphasisIndex !== -1) {
-          pendingError = pendingError ||
-            handleRunEnd(line, lineIndex, 0, null, line.length, inTable);
-          // Adjust for pending run on new line
-          emphasisIndex = 0;
-          emphasisLength = 0;
-        }
       }
-    );
+    }
   }
 };

package/lib/md038.js

@@ -3,7 +3,7 @@
 "use strict";
 
 const { addErrorContext } = require("../helpers");
-const { filterByTypes } = require("../helpers/micromark.cjs");
+const { filterByTypes, tokenIfType } = require("../helpers/micromark.cjs");
 
 const leftSpaceRe = /^\s(?:[^`]|$)/;
 const rightSpaceRe = /[^`]\s$/;
@@ -17,7 +17,6 @@ const trimCodeText = (text, start, end) => {
   }
   return text;
 };
-const tokenIfType = (token, type) => token && (token.type === type) && token;
 
 module.exports = {
   "names": [ "MD038", "no-space-in-code" ],

package/lib/md044.js

@@ -2,7 +2,7 @@
 
 "use strict";
 
-const { addErrorDetailIf, escapeForRegExp, withinAnyRange } =
+const { addErrorDetailIf, escapeForRegExp, newLineRe, withinAnyRange } =
   require("../helpers");
 const { filterByPredicate, filterByTypes, parse } =
   require("../helpers/micromark.cjs");
@@ -30,14 +30,32 @@ module.exports = {
       scannedTypes.add("codeFlowValue");
       scannedTypes.add("codeTextData");
     }
+    const tokenAdjustments = new Map();
     const contentTokens =
       filterByPredicate(
         params.parsers.micromark.tokens,
         (token) => scannedTypes.has(token.type),
         (token) => {
           let { children } = token;
+          const { startLine, text } = token;
           if (!includeHtmlElements && (token.type === "htmlFlow")) {
-            children = children.slice(1, -1);
+            if (text.startsWith("<!--")) {
+              // Remove comment content
+              children = [];
+            } else {
+              // Re-parse to get htmlText elements for detailed tokenization
+              const htmlTextLines =
+                `<md044>\n${text}\n</md044>`.split(newLineRe);
+              children = parse(htmlTextLines.join(""));
+              const reTokens = [ ...children ];
+              for (const reToken of reTokens) {
+                tokenAdjustments.set(reToken, {
+                  htmlTextLines,
+                  startLine
+                });
+                reTokens.push(...reToken.children);
+              }
+            }
           }
           return children.filter((t) => !ignoredChildTypes.has(t.type));
         }
@@ -78,10 +96,22 @@ module.exports = {
               autoLinked.add(token);
             }
             if (!withinAnyRange(urlRanges, lineIndex, index, length)) {
-              const column = index + 1;
+              let lineNumber = token.startLine;
+              let column = index;
+              if (tokenAdjustments.has(token)) {
+                const { htmlTextLines, startLine } =
+                  tokenAdjustments.get(token);
+                let lineDelta = 0;
+                while (htmlTextLines[lineDelta].length <= column) {
+                  column -= htmlTextLines[lineDelta].length;
+                  lineDelta++;
+                }
+                lineNumber = startLine + lineDelta - 1;
+              }
+              column++;
               addErrorDetailIf(
                 onError,
-                token.startLine,
+                lineNumber,
                 name,
                 nameMatch,
                 null,

package/lib/md045.js

@@ -2,17 +2,29 @@
 
 "use strict";
 
-const { addError, forEachInlineChild } = require("../helpers");
+const { addError } = require("../helpers");
+const { filterByTypes } = require("../helpers/micromark.cjs");
 
 module.exports = {
   "names": [ "MD045", "no-alt-text" ],
   "description": "Images should have alternate text (alt text)",
   "tags": [ "accessibility", "images" ],
   "function": function MD045(params, onError) {
-    forEachInlineChild(params, "image", function forToken(token) {
-      if (token.content === "") {
-        addError(onError, token.lineNumber);
+    const images = filterByTypes(params.parsers.micromark.tokens, [ "image" ]);
+    for (const image of images) {
+      const labelTexts = filterByTypes(image.children, [ "labelText" ]);
+      if (labelTexts.some((labelText) => labelText.text.length === 0)) {
+        const range = (image.startLine === image.endLine) ?
+          [ image.startColumn, image.endColumn - image.startColumn ] :
+          undefined;
+        addError(
+          onError,
+          image.startLine,
+          undefined,
+          undefined,
+          range
+        );
       }
-    });
+    }
   }
 };