markdownlint 0.34.0 → 0.36.0

package/lib/md049-md050.js

@@ -2,11 +2,26 @@
 
 "use strict";
 
-const { addError, emphasisOrStrongStyleFor } = require("../helpers");
-const { filterByPredicate, tokenIfType } = require("../helpers/micromark.cjs");
+const { addError } = require("../helpers");
+const { filterByPredicate, getDescendantsByType } = require("../helpers/micromark-helpers.cjs");
 
 const intrawordRe = /^\w$/;
 
+/**
+ * Return the string representation of a emphasis or strong markup character.
+ *
+ * @param {string} markup Emphasis or strong string.
+ * @returns {"asterisk" | "underscore"} String representation.
+ */
+function emphasisOrStrongStyleFor(markup) {
+  switch (markup[0]) {
+    case "*":
+      return "asterisk";
+    default:
+      return "underscore";
+  }
+};
+
 /**
  * @param {import("./markdownlint").RuleParams} params Rule parameters.
  * @param {import("./markdownlint").RuleOnError} onError Error-reporting callback.
@@ -18,21 +33,16 @@ const intrawordRe = /^\w$/;
  */
 const impl =
   (params, onError, type, typeSequence, asterisk, underline, style = "consistent") => {
-    // eslint-disable-next-line jsdoc/valid-types
-    /** @type import("../helpers/micromark.cjs").Token[] */
-    const micromarkTokens =
-      // @ts-ignore
-      params.parsers.micromark.tokens;
-    const { lines } = params;
+    const { lines, parsers } = params;
     const emphasisTokens = filterByPredicate(
-      micromarkTokens,
+      parsers.micromark.tokens,
       (token) => token.type === type,
       (token) => ((token.type === "htmlFlow") ? [] : token.children)
     );
     for (const token of emphasisTokens) {
-      const { children } = token;
-      const startSequence = tokenIfType(children[0], typeSequence);
-      const endSequence = tokenIfType(children[children.length - 1], typeSequence);
+      const sequences = getDescendantsByType(token, [ typeSequence ]);
+      const startSequence = sequences[0];
+      const endSequence = sequences[sequences.length - 1];
       if (startSequence && endSequence) {
         const markupStyle = emphasisOrStrongStyleFor(startSequence.text);
         if (style === "consistent") {

package/lib/md051.js

@@ -2,10 +2,9 @@
 
 "use strict";
 
-const { addError, addErrorDetailIf, getHtmlAttributeRe } =
-  require("../helpers");
-const { filterByPredicate, filterByTypes, getHtmlTagInfo } =
-  require("../helpers/micromark.cjs");
+const { addError, getHtmlAttributeRe } = require("../helpers");
+const { filterByPredicate, filterByTypes, getHtmlTagInfo } = require("../helpers/micromark-helpers.cjs");
+const { filterByTypesCached } = require("./cache");
 
 // Regular expression for identifying HTML anchor names
 const idRe = getHtmlAttributeRe("id");
@@ -23,7 +22,7 @@ const tokensInclude = new Set(
  * Converts a Markdown heading into an HTML fragment according to the rules
  * used by GitHub.
  *
- * @param {import("../helpers/micromark.cjs").Token} headingText Heading text token.
+ * @param {import("../helpers/micromark-helpers.cjs").Token} headingText Heading text token.
  * @returns {string} Fragment string for heading.
  */
 function convertHeadingToHTMLFragment(headingText) {
@@ -52,7 +51,7 @@ function convertHeadingToHTMLFragment(headingText) {
 /**
  * Unescapes the text of a String-type micromark Token.
  *
- * @param {import("../helpers/micromark.cjs").Token} token String-type micromark Token.
+ * @param {import("../helpers/micromark-helpers.cjs").Token} token String-type micromark Token.
  * @returns {string} Unescaped token text.
  */
 function unescapeStringTokenText(token) {
@@ -69,15 +68,11 @@ module.exports = {
   "tags": [ "links" ],
   "parser": "micromark",
   "function": function MD051(params, onError) {
-    // eslint-disable-next-line jsdoc/valid-types
-    /** @type import("../helpers/micromark.cjs").Token[] */
-    const micromarkTokens =
-      // @ts-ignore
-      params.parsers.micromark.tokens;
+    const ignoreCase = params.config.ignore_case || false;
     const fragments = new Map();
 
     // Process headings
-    const headingTexts = filterByTypes(micromarkTokens, [ "atxHeadingText", "setextHeadingText" ]);
+    const headingTexts = filterByTypesCached([ "atxHeadingText", "setextHeadingText" ]);
     for (const headingText of headingTexts) {
       const fragment = convertHeadingToHTMLFragment(headingText);
       if (fragment !== "#") {
@@ -97,7 +92,7 @@ module.exports = {
     }
 
     // Process HTML anchors
-    for (const token of filterByTypes(micromarkTokens, [ "htmlText" ])) {
+    for (const token of filterByTypesCached([ "htmlText" ], true)) {
       const htmlTagInfo = getHtmlTagInfo(token);
       if (htmlTagInfo && !htmlTagInfo.close) {
         const anchorMatch = idRe.exec(token.text) ||
@@ -110,13 +105,13 @@ module.exports = {
 
     // Process link and definition fragments
     // eslint-disable-next-line jsdoc/valid-types
-    /** @type import("../helpers/micromark.cjs").TokenType[][] */
+    /** @type import("../helpers/micromark-helpers.cjs").TokenType[][] */
     const parentChilds = [
       [ "link", "resourceDestinationString" ],
       [ "definition", "definitionDestinationString" ]
     ];
     for (const [ parentType, definitionType ] of parentChilds) {
-      const links = filterByTypes(micromarkTokens, [ parentType ]);
+      const links = filterByTypesCached([ parentType ]);
       for (const link of links) {
         const definitions = filterByTypes(link.children, [ definitionType ]);
         for (const definition of definitions) {
@@ -129,11 +124,8 @@ module.exports = {
             !fragments.has(encodedText) &&
             !lineFragmentRe.test(encodedText)
           ) {
-            // eslint-disable-next-line no-undef-init
             let context = undefined;
-            // eslint-disable-next-line no-undef-init
             let range = undefined;
-            // eslint-disable-next-line no-undef-init
             let fixInfo = undefined;
             if (link.startLine === link.endLine) {
               context = link.text;
@@ -149,16 +141,16 @@ module.exports = {
             if (mixedCaseKey) {
               // @ts-ignore
               (fixInfo || {}).insertText = mixedCaseKey;
-              addErrorDetailIf(
-                onError,
-                link.startLine,
-                mixedCaseKey,
-                text,
-                undefined,
-                context,
-                range,
-                fixInfo
-              );
+              if (!ignoreCase && (mixedCaseKey !== text)) {
+                addError(
+                  onError,
+                  link.startLine,
+                  `Expected: ${mixedCaseKey}; Actual: ${text}`,
+                  context,
+                  range,
+                  fixInfo
+                );
+              }
             } else {
               addError(
                 onError,

package/lib/md052.js

@@ -3,7 +3,7 @@
 "use strict";
 
 const { addError } = require("../helpers");
-const { referenceLinkImageData } = require("./cache");
+const { getReferenceLinkImageData } = require("./cache");
 
 // eslint-disable-next-line jsdoc/valid-types
 /** @type import("./markdownlint").Rule */
@@ -16,7 +16,7 @@ module.exports = {
   "function": function MD052(params, onError) {
     const { config, lines } = params;
     const shortcutSyntax = config.shortcut_syntax || false;
-    const { definitions, references, shortcuts } = referenceLinkImageData();
+    const { definitions, references, shortcuts } = getReferenceLinkImageData();
     const entries = shortcutSyntax ?
       [ ...references.entries(), ...shortcuts.entries() ] :
       references.entries();

package/lib/md053.js

@@ -2,9 +2,10 @@
 
 "use strict";
 
-const { addError, ellipsify, linkReferenceDefinitionRe } =
-  require("../helpers");
-const { referenceLinkImageData } = require("./cache");
+const { addError, ellipsify } = require("../helpers");
+const { getReferenceLinkImageData } = require("./cache");
+
+const linkReferenceDefinitionRe = /^ {0,3}\[([^\]]*[^\\])\]:/;
 
 // eslint-disable-next-line jsdoc/valid-types
 /** @type import("./markdownlint").Rule */
@@ -17,7 +18,7 @@ module.exports = {
     const ignored = new Set(params.config.ignored_definitions || [ "//" ]);
     const lines = params.lines;
     const { references, shortcuts, definitions, duplicateDefinitions } =
-      referenceLinkImageData();
+      getReferenceLinkImageData();
     const singleLineDefinition = (line) => (
       line.replace(linkReferenceDefinitionRe, "").trim().length > 0
     );
@@ -39,7 +40,7 @@ module.exports = {
           `Unused link or image reference definition: "${label}"`,
           ellipsify(line),
           [ 1, line.length ],
-          singleLineDefinition(line) ? deleteFixInfo : 0
+          singleLineDefinition(line) ? deleteFixInfo : undefined
         );
       }
     }
@@ -54,7 +55,7 @@ module.exports = {
           `Duplicate link or image reference definition: "${label}"`,
           ellipsify(line),
           [ 1, line.length ],
-          singleLineDefinition(line) ? deleteFixInfo : 0
+          singleLineDefinition(line) ? deleteFixInfo : undefined
         );
       }
     }

package/lib/md054.js

@@ -3,9 +3,8 @@
 "use strict";
 
 const { addErrorContext, nextLinesRe } = require("../helpers");
-const { filterByTypes, filterByPredicate, getTokenTextByType } =
-  require("../helpers/micromark.cjs");
-const { referenceLinkImageData } = require("./cache");
+const { getDescendantsByType } = require("../helpers/micromark-helpers.cjs");
+const { getReferenceLinkImageData, filterByTypesCached } = require("./cache");
 
 const backslashEscapeRe = /\\([!"#$%&'()*+,\-./:;<=>?@[\\\]^_`{|}~])/g;
 const removeBackslashEscapes = (text) => text.replace(backslashEscapeRe, "$1");
@@ -40,35 +39,29 @@ module.exports = {
       // Everything allowed, nothing to check
       return;
     }
-    // eslint-disable-next-line jsdoc/valid-types
-    /** @type import("../helpers/micromark.cjs").Token[] */
-    const micromarkTokens =
-      // @ts-ignore
-      params.parsers.micromark.tokens;
-    const { definitions } = referenceLinkImageData();
-    const links = filterByTypes(micromarkTokens, [ "autolink", "image", "link" ]);
+    const { definitions } = getReferenceLinkImageData();
+    const links = filterByTypesCached([ "autolink", "image", "link" ]);
     for (const link of links) {
       let label = null;
       let destination = null;
       const {
-        children, endColumn, endLine, startColumn, startLine, text, type
+        endColumn, endLine, startColumn, startLine, text, type
       } = link;
       const image = (type === "image");
       let isError = false;
       if (type === "autolink") {
         // link kind is an autolink
-        destination = getTokenTextByType(children, "autolinkProtocol");
+        destination = getDescendantsByType(link, [ "autolinkProtocol" ])[0].text;
         label = destination;
         isError = !autolink;
       } else {
         // link type is "image" or "link"
-        const descendents = filterByPredicate(children);
-        label = getTokenTextByType(descendents, "labelText");
+        label = getDescendantsByType(link, [ "label", "labelText" ])[0].text;
         destination =
-          getTokenTextByType(descendents, "resourceDestinationString");
+          getDescendantsByType(link, [ "resource", "resourceDestination", [ "resourceDestinationLiteral", "resourceDestinationRaw" ], "resourceDestinationString" ])[0]?.text;
         if (destination) {
           // link kind is an inline link
-          const title = getTokenTextByType(descendents, "resourceTitleString");
+          const title = getDescendantsByType(link, [ "resource", "resourceTitle", "resourceTitleString" ])[0]?.text;
           isError = !inline || (
             !urlInline &&
             autolink &&
@@ -79,9 +72,9 @@ module.exports = {
           );
         } else {
           // link kind is a full/collapsed/shortcut reference link
-          const isShortcut = !children.some((t) => t.type === "reference");
-          const referenceString = getTokenTextByType(descendents, "referenceString");
-          const isCollapsed = (referenceString === null);
+          const isShortcut = getDescendantsByType(link, [ "reference" ]).length === 0;
+          const referenceString = getDescendantsByType(link, [ "reference", "referenceString" ])[0]?.text;
+          const isCollapsed = (referenceString === undefined);
           const definition = definitions.get(referenceString || label);
           destination = definition && definition[1];
           isError = destination &&
@@ -89,8 +82,8 @@ module.exports = {
         }
       }
       if (isError) {
-        let range = null;
-        let fixInfo = null;
+        let range = undefined;
+        let fixInfo = undefined;
         if (startLine === endLine) {
           range = [ startColumn, endColumn - startColumn ];
           let insertText = null;
@@ -119,8 +112,8 @@ module.exports = {
           onError,
           startLine,
           text.replace(nextLinesRe, ""),
-          null,
-          null,
+          undefined,
+          undefined,
           range,
           fixInfo
         );

package/lib/md055.js

@@ -3,7 +3,7 @@
 "use strict";
 
 const { addErrorDetailIf } = require("../helpers");
-const { filterByTypes } = require("../helpers/micromark.cjs");
+const { filterByTypesCached } = require("./cache");
 
 const whitespaceTypes = new Set([ "linePrefix", "whitespace" ]);
 const ignoreWhitespace = (tokens) => tokens.filter(
@@ -27,54 +27,46 @@ module.exports = {
       ((expectedStyle !== "no_leading_or_trailing") && (expectedStyle !== "trailing_only"));
     let expectedTrailingPipe =
       ((expectedStyle !== "no_leading_or_trailing") && (expectedStyle !== "leading_only"));
-    // eslint-disable-next-line jsdoc/valid-types
-    /** @type import("../helpers/micromark.cjs").Token[] */
-    const micromarkTokens =
-      // @ts-ignore
-      params.parsers.micromark.tokens;
-    const tables = filterByTypes(micromarkTokens, [ "table" ]);
-    for (const table of tables) {
-      const rows = filterByTypes(table.children, [ "tableDelimiterRow", "tableRow" ]);
-      for (const row of rows) {
-        // The following uses of first/lastOrNothing lack fallback handling
-        // because it seems not to be possible (i.e., 0% coverage)
-        const firstCell = firstOrNothing(row.children);
-        const leadingToken = firstOrNothing(ignoreWhitespace(firstCell.children));
-        const actualLeadingPipe = (leadingToken.type === "tableCellDivider");
-        const lastCell = lastOrNothing(row.children);
-        const trailingToken = lastOrNothing(ignoreWhitespace(lastCell.children));
-        const actualTrailingPipe = (trailingToken.type === "tableCellDivider");
-        const actualStyle = actualLeadingPipe ?
-          (actualTrailingPipe ? "leading_and_trailing" : "leading_only") :
-          (actualTrailingPipe ? "trailing_only" : "no_leading_or_trailing");
-        if (expectedStyle === "consistent") {
-          expectedStyle = actualStyle;
-          expectedLeadingPipe = actualLeadingPipe;
-          expectedTrailingPipe = actualTrailingPipe;
-        }
-        if (actualLeadingPipe !== expectedLeadingPipe) {
-          addErrorDetailIf(
-            onError,
-            firstCell.startLine,
-            expectedStyle,
-            actualStyle,
-            `${expectedLeadingPipe ? "Missing" : "Unexpected"} leading pipe`,
-            undefined,
-            makeRange(row.startColumn, firstCell.startColumn)
-          );
-        }
-        if (actualTrailingPipe !== expectedTrailingPipe) {
-          addErrorDetailIf(
-            onError,
-            lastCell.endLine,
-            expectedStyle,
-            actualStyle,
-            `${expectedTrailingPipe ? "Missing" : "Unexpected"} trailing pipe`,
-            undefined,
-            makeRange(lastCell.endColumn - 1, row.endColumn - 1)
-          );
-        }
+    const rows = filterByTypesCached([ "tableDelimiterRow", "tableRow" ]);
+    for (const row of rows) {
+      // The following uses of first/lastOrNothing lack fallback handling
+      // because it seems not to be possible (i.e., 0% coverage)
+      const firstCell = firstOrNothing(row.children);
+      const leadingToken = firstOrNothing(ignoreWhitespace(firstCell.children));
+      const actualLeadingPipe = (leadingToken.type === "tableCellDivider");
+      const lastCell = lastOrNothing(row.children);
+      const trailingToken = lastOrNothing(ignoreWhitespace(lastCell.children));
+      const actualTrailingPipe = (trailingToken.type === "tableCellDivider");
+      const actualStyle = actualLeadingPipe ?
+        (actualTrailingPipe ? "leading_and_trailing" : "leading_only") :
+        (actualTrailingPipe ? "trailing_only" : "no_leading_or_trailing");
+      if (expectedStyle === "consistent") {
+        expectedStyle = actualStyle;
+        expectedLeadingPipe = actualLeadingPipe;
+        expectedTrailingPipe = actualTrailingPipe;
+      }
+      if (actualLeadingPipe !== expectedLeadingPipe) {
+        addErrorDetailIf(
+          onError,
+          firstCell.startLine,
+          expectedStyle,
+          actualStyle,
+          `${expectedLeadingPipe ? "Missing" : "Unexpected"} leading pipe`,
+          undefined,
+          makeRange(row.startColumn, firstCell.startColumn)
+        );
+      }
+      if (actualTrailingPipe !== expectedTrailingPipe) {
+        addErrorDetailIf(
+          onError,
+          lastCell.endLine,
+          expectedStyle,
+          actualStyle,
+          `${expectedTrailingPipe ? "Missing" : "Unexpected"} trailing pipe`,
+          undefined,
+          makeRange(lastCell.endColumn - 1, row.endColumn - 1)
+        );
       }
     }
   }
-}
+};

package/lib/md056.js

@@ -3,7 +3,8 @@
 "use strict";
 
 const { addErrorDetailIf } = require("../helpers");
-const { filterByTypes } = require("../helpers/micromark.cjs");
+const { getParentOfType } = require("../helpers/micromark-helpers.cjs");
+const { filterByTypesCached } = require("./cache");
 
 const makeRange = (start, end) => [ start, end - start + 1 ];
 
@@ -15,38 +16,36 @@ module.exports = {
   "tags": [ "table" ],
   "parser": "micromark",
   "function": function MD056(params, onError) {
-    // eslint-disable-next-line jsdoc/valid-types
-    /** @type import("../helpers/micromark.cjs").Token[] */
-    const micromarkTokens =
-      // @ts-ignore
-      params.parsers.micromark.tokens;
-    const tables = filterByTypes(micromarkTokens, [ "table" ]);
-    for (const table of tables) {
-      const rows = filterByTypes(table.children, [ "tableDelimiterRow", "tableRow" ]);
-      let expectedCount = 0;
-      for (const row of rows) {
-        const cells = filterByTypes(row.children, [ "tableData", "tableDelimiter", "tableHeader" ]);
-        const actualCount = cells.length;
-        expectedCount ||= actualCount;
-        let detail = null;
-        let range = null;
-        if (actualCount < expectedCount) {
-          detail = "Too few cells, row will be missing data";
-          range = [ row.endColumn - 1, 1 ];
-        } else if (expectedCount < actualCount) {
-          detail = "Too many cells, extra data will be missing";
-          range = makeRange(cells[expectedCount].startColumn, row.endColumn - 1);
-        }
-        addErrorDetailIf(
-          onError,
-          row.endLine,
-          expectedCount,
-          actualCount,
-          detail,
-          null,
-          range
-        );
+    const rows = filterByTypesCached([ "tableDelimiterRow", "tableRow" ]);
+    let expectedCount = 0;
+    let currentTable = null;
+    for (const row of rows) {
+      const table = getParentOfType(row, [ "table" ]);
+      if (currentTable !== table) {
+        expectedCount = 0;
+        currentTable = table;
       }
+      const cells = row.children.filter((child) => [ "tableData", "tableDelimiter", "tableHeader" ].includes(child.type));
+      const actualCount = cells.length;
+      expectedCount ||= actualCount;
+      let detail = undefined;
+      let range = undefined;
+      if (actualCount < expectedCount) {
+        detail = "Too few cells, row will be missing data";
+        range = [ row.endColumn - 1, 1 ];
+      } else if (expectedCount < actualCount) {
+        detail = "Too many cells, extra data will be missing";
+        range = makeRange(cells[expectedCount].startColumn, row.endColumn - 1);
+      }
+      addErrorDetailIf(
+        onError,
+        row.endLine,
+        expectedCount,
+        actualCount,
+        detail,
+        undefined,
+        range
+      );
     }
   }
-}
+};

package/lib/md058.js

@@ -0,0 +1,58 @@
+// @ts-check
+
+"use strict";
+
+const { addErrorContext, isBlankLine } = require("../helpers");
+const { getBlockQuotePrefixText } = require("../helpers/micromark-helpers.cjs");
+const { filterByTypesCached } = require("./cache");
+
+// eslint-disable-next-line jsdoc/valid-types
+/** @type import("./markdownlint").Rule */
+module.exports = {
+  "names": [ "MD058", "blanks-around-tables" ],
+  "description": "Tables should be surrounded by blank lines",
+  "tags": [ "table" ],
+  "parser": "micromark",
+  "function": function MD058(params, onError) {
+    const { lines } = params;
+    const blockQuotePrefixes = filterByTypesCached([ "blockQuotePrefix", "linePrefix" ]);
+
+    // For every table...
+    const tables = filterByTypesCached([ "table" ]);
+    for (const table of tables) {
+
+      // Look for a blank line above the table
+      const firstLineNumber = table.startLine;
+      if (!isBlankLine(lines[firstLineNumber - 2])) {
+        addErrorContext(
+          onError,
+          firstLineNumber,
+          lines[firstLineNumber - 1].trim(),
+          undefined,
+          undefined,
+          undefined,
+          {
+            "insertText": getBlockQuotePrefixText(blockQuotePrefixes, firstLineNumber)
+          }
+        );
+      }
+
+      // Look for a blank line below the table
+      const lastLineNumber = table.endLine;
+      if (!isBlankLine(lines[lastLineNumber])) {
+        addErrorContext(
+          onError,
+          lastLineNumber,
+          lines[lastLineNumber - 1].trim(),
+          undefined,
+          undefined,
+          undefined,
+          {
+            "lineNumber": lastLineNumber + 1,
+            "insertText": getBlockQuotePrefixText(blockQuotePrefixes, lastLineNumber)
+          }
+        );
+      }
+    }
+  }
+};

package/lib/rules.js

@@ -4,6 +4,11 @@
 
 const { homepage, version } = require("./constants");
 
+// @ts-ignore
+const [ md019, md021 ] = require("./md019-md021");
+// @ts-ignore
+const [ md049, md050 ] = require("./md049-md050");
+
 const rules = [
   require("./md001"),
   // md002: Deprecated and removed
@@ -19,9 +24,9 @@ const rules = [
   require("./md013"),
   require("./md014"),
   require("./md018"),
-  require("./md019"),
+  md019,
   require("./md020"),
-  require("./md021"),
+  md021,
   require("./md022"),
   require("./md023"),
   require("./md024"),
@@ -49,14 +54,16 @@ const rules = [
   require("./md046"),
   require("./md047"),
   require("./md048"),
-  ...require("./md049-md050"),
+  md049,
+  md050,
   require("./md051"),
   require("./md052"),
   require("./md053"),
   require("./md054"),
   require("./md055"),
-  require("./md056")
+  require("./md056"),
   // md057: See https://github.com/markdownlint/markdownlint
+  require("./md058")
 ];
 for (const rule of rules) {
   const name = rule.names[0].toLowerCase();