markdownlint 0.21.1 → 0.24.0

package/lib/markdownlint.js

@@ -2,14 +2,18 @@
 
 "use strict";
 
-const fs = require("fs");
 const path = require("path");
-const util = require("util");
+const { promisify } = require("util");
 const markdownIt = require("markdown-it");
 const rules = require("./rules");
 const helpers = require("../helpers");
 const cache = require("./cache");
 
+// @ts-ignore
+// eslint-disable-next-line camelcase, max-len, no-inline-comments, no-undef
+const dynamicRequire = (typeof __non_webpack_require__ === "undefined") ? require : /* c8 ignore next */ __non_webpack_require__;
+// Capture native require implementation for dynamic loading of modules
+
 const deprecatedRuleNames = [ "MD002", "MD006" ];
 
 /**
@@ -51,10 +55,12 @@ function validateRuleList(ruleList) {
         result = newError(property);
       }
     });
-    if (!result && rule.information) {
-      if (Object.getPrototypeOf(rule.information) !== URL.prototype) {
-        result = newError("information");
-      }
+    if (
+      !result &&
+      rule.information &&
+      (Object.getPrototypeOf(rule.information) !== URL.prototype)
+    ) {
+      result = newError("information");
     }
     if (!result) {
       rule.names.forEach(function forName(name) {
@@ -176,18 +182,27 @@ function removeFrontMatter(content, frontMatter) {
  * @returns {void}
  */
 function annotateTokens(tokens, lines) {
-  let tbodyMap = null;
+  let tableMap = null;
   tokens.forEach(function forToken(token) {
-    // Handle missing maps for table body
-    if (token.type === "tbody_open") {
-      tbodyMap = token.map.slice();
-    } else if ((token.type === "tr_close") && tbodyMap) {
-      tbodyMap[0]++;
-    } else if (token.type === "tbody_close") {
-      tbodyMap = null;
+    // Handle missing maps for table head/body
+    if (
+      (token.type === "thead_open") ||
+      (token.type === "tbody_open")
+    ) {
+      tableMap = [ ...token.map ];
+    } else if (
+      (token.type === "tr_close") &&
+      tableMap
+    ) {
+      tableMap[0]++;
+    } else if (
+      (token.type === "thead_close") ||
+      (token.type === "tbody_close")
+    ) {
+      tableMap = null;
     }
-    if (tbodyMap && !token.map) {
-      token.map = tbodyMap.slice();
+    if (tableMap && !token.map) {
+      token.map = [ ...tableMap ];
     }
     // Update token metadata
     if (token.map) {
@@ -322,13 +337,13 @@ function getEnabledRulesPerLineNumber(
   // eslint-disable-next-line jsdoc/require-jsdoc
   function handleInlineConfig(perLine, forEachMatch, forEachLine) {
     const input = perLine ? lines : [ lines.join("\n") ];
-    input.forEach((line) => {
+    input.forEach((line, lineIndex) => {
       if (!noInlineConfig) {
         let match = null;
         while ((match = helpers.inlineCommentRe.exec(line))) {
           const action = (match[1] || match[3]).toUpperCase();
           const parameter = match[2] || match[4];
-          forEachMatch(action, parameter);
+          forEachMatch(action, parameter, lineIndex + 1);
         }
       }
       if (forEachLine) {
@@ -351,21 +366,21 @@ function getEnabledRulesPerLineNumber(
     }
   }
   // eslint-disable-next-line jsdoc/require-jsdoc
-  function applyEnableDisable(action, parameter) {
+  function applyEnableDisable(action, parameter, state) {
     const enabled = (action.startsWith("ENABLE"));
     const items = parameter ?
       parameter.trim().toUpperCase().split(/\s+/) :
       allRuleNames;
     items.forEach((nameUpper) => {
       (aliasToRuleNames[nameUpper] || []).forEach((ruleName) => {
-        enabledRules[ruleName] = enabled;
+        state[ruleName] = enabled;
       });
     });
   }
   // eslint-disable-next-line jsdoc/require-jsdoc
   function enableDisableFile(action, parameter) {
     if ((action === "ENABLE-FILE") || (action === "DISABLE-FILE")) {
-      applyEnableDisable(action, parameter);
+      applyEnableDisable(action, parameter, enabledRules);
     }
   }
   // eslint-disable-next-line jsdoc/require-jsdoc
@@ -376,12 +391,22 @@ function getEnabledRulesPerLineNumber(
       enabledRules = { ...capturedRules };
     } else if ((action === "ENABLE") || (action === "DISABLE")) {
       enabledRules = { ...enabledRules };
-      applyEnableDisable(action, parameter);
+      applyEnableDisable(action, parameter, enabledRules);
     }
   }
   // eslint-disable-next-line jsdoc/require-jsdoc
   function updateLineState() {
-    enabledRulesPerLineNumber.push(enabledRules);
+    enabledRulesPerLineNumber.push({ ...enabledRules });
+  }
+  // eslint-disable-next-line jsdoc/require-jsdoc
+  function disableNextLine(action, parameter, lineNumber) {
+    if (action === "DISABLE-NEXT-LINE") {
+      applyEnableDisable(
+        action,
+        parameter,
+        enabledRulesPerLineNumber[lineNumber + 1] || {}
+      );
+    }
   }
   // Handle inline comments
   handleInlineConfig(false, configureFile);
@@ -395,6 +420,7 @@ function getEnabledRulesPerLineNumber(
   capturedRules = enabledRules;
   handleInlineConfig(true, enableDisableFile);
   handleInlineConfig(true, captureRestoreEnableDisable, updateLineState);
+  handleInlineConfig(true, disableNextLine);
   // Return results
   return {
     effectiveConfig,
@@ -439,8 +465,8 @@ function uniqueFilterForSortedErrors(value, index, array) {
  *
  * @param {Rule[]} ruleList List of rules.
  * @param {string} name Identifier for the content.
- * @param {string} content Markdown content
- * @param {Object} md markdown-it instance.
+ * @param {string} content Markdown content.
+ * @param {Object} md Instance of markdown-it.
  * @param {Configuration} config Configuration object.
  * @param {RegExp} frontMatter Regular expression for front matter.
  * @param {boolean} handleRuleFailures Whether to handle exceptions in rules.
@@ -489,7 +515,8 @@ function lintContent(
     frontMatterLines
   };
   cache.lineMetadata(helpers.getLineMetadata(params));
-  cache.flattenedLists(helpers.flattenLists(params));
+  cache.flattenedLists(helpers.flattenLists(params.tokens));
+  cache.inlineCodeSpanRanges(helpers.inlineCodeSpanRanges(params.lines));
   // Function to run for each rule
   const result = (resultVersion === 0) ? {} : [];
   // eslint-disable-next-line jsdoc/require-jsdoc
@@ -651,12 +678,13 @@ function lintContent(
  *
  * @param {Rule[]} ruleList List of rules.
  * @param {string} file Path of file to lint.
- * @param {Object} md markdown-it instance.
+ * @param {Object} md Instance of markdown-it.
  * @param {Configuration} config Configuration object.
  * @param {RegExp} frontMatter Regular expression for front matter.
  * @param {boolean} handleRuleFailures Whether to handle exceptions in rules.
  * @param {boolean} noInlineConfig Whether to allow inline configuration.
  * @param {number} resultVersion Version of the LintResults object to return.
+ * @param {Object} fs File system implementation.
  * @param {boolean} synchronous Whether to execute synchronously.
  * @param {Function} callback Callback (err, result) function.
  * @returns {void}
@@ -670,6 +698,7 @@ function lintFile(
   handleRuleFailures,
   noInlineConfig,
   resultVersion,
+  fs,
   synchronous,
   callback) {
   // eslint-disable-next-line jsdoc/require-jsdoc
@@ -682,10 +711,9 @@ function lintFile(
   }
   // Make a/synchronous call to read file
   if (synchronous) {
-    // @ts-ignore
-    lintContentWrapper(null, fs.readFileSync(file, helpers.utf8Encoding));
+    lintContentWrapper(null, fs.readFileSync(file, "utf8"));
   } else {
-    fs.readFile(file, helpers.utf8Encoding, lintContentWrapper);
+    fs.readFile(file, "utf8", lintContentWrapper);
   }
 }
 
@@ -701,6 +729,7 @@ function lintInput(options, synchronous, callback) {
   // Normalize inputs
   options = options || {};
   callback = callback || function noop() {};
+  // eslint-disable-next-line unicorn/prefer-spread
   const ruleList = rules.concat(options.customRules || []);
   const ruleErr = validateRuleList(ruleList);
   if (ruleErr) {
@@ -708,7 +737,7 @@ function lintInput(options, synchronous, callback) {
   }
   let files = [];
   if (Array.isArray(options.files)) {
-    files = options.files.slice();
+    files = [ ...options.files ];
   } else if (options.files) {
     files = [ String(options.files) ];
   }
@@ -727,6 +756,7 @@ function lintInput(options, synchronous, callback) {
     // @ts-ignore
     md.use(...plugin);
   });
+  const fs = options.fs || require("fs");
   const results = newResults(ruleList);
   let done = false;
   // Linting of strings is always synchronous
@@ -766,6 +796,7 @@ function lintInput(options, synchronous, callback) {
         handleRuleFailures,
         noInlineConfig,
         resultVersion,
+        fs,
         synchronous,
         syncCallback
       );
@@ -790,6 +821,7 @@ function lintInput(options, synchronous, callback) {
         handleRuleFailures,
         noInlineConfig,
         resultVersion,
+        fs,
         synchronous,
         (err, result) => {
           concurrency--;
@@ -833,7 +865,7 @@ function markdownlint(options, callback) {
   return lintInput(options, false, callback);
 }
 
-const markdownlintPromisify = util.promisify(markdownlint);
+const markdownlintPromisify = promisify && promisify(markdownlint);
 
 /**
  * Lint specified Markdown files.
@@ -894,23 +926,91 @@ function parseConfiguration(name, content, parsers) {
   };
 }
 
+/**
+ * Resolve referenced "extends" path in a configuration file
+ * using path.resolve() with require.resolve() as a fallback.
+ *
+ * @param {string} configFile Configuration file name.
+ * @param {string} referenceId Referenced identifier to resolve.
+ * @param {Object} fs File system implementation.
+ * @param {ResolveConfigExtendsCallback} [callback] Callback (err, result)
+ * function.
+ * @returns {void}
+ */
+function resolveConfigExtends(configFile, referenceId, fs, callback) {
+  const configFileDirname = path.dirname(configFile);
+  const resolvedExtendsFile = path.resolve(configFileDirname, referenceId);
+  fs.access(resolvedExtendsFile, (err) => {
+    if (err) {
+      // Not a file, try require.resolve
+      try {
+        return callback(null, dynamicRequire.resolve(
+          referenceId,
+          { "paths": [ configFileDirname ] }
+        ));
+      } catch {
+        // Unable to resolve, use resolvedExtendsFile
+      }
+    }
+    return callback(null, resolvedExtendsFile);
+  });
+}
+
+/**
+ * Resolve referenced "extends" path in a configuration file
+ * using path.resolve() with require.resolve() as a fallback.
+ *
+ * @param {string} configFile Configuration file name.
+ * @param {string} referenceId Referenced identifier to resolve.
+ * @param {Object} fs File system implementation.
+ * @returns {string} Resolved path to file.
+ */
+function resolveConfigExtendsSync(configFile, referenceId, fs) {
+  const configFileDirname = path.dirname(configFile);
+  const resolvedExtendsFile = path.resolve(configFileDirname, referenceId);
+  try {
+    fs.accessSync(resolvedExtendsFile);
+    return resolvedExtendsFile;
+  } catch {
+    // Not a file, try require.resolve
+  }
+  try {
+    return dynamicRequire.resolve(
+      referenceId,
+      { "paths": [ configFileDirname ] }
+    );
+  } catch {
+    // Unable to resolve, return resolvedExtendsFile
+  }
+  return resolvedExtendsFile;
+}
+
 /**
  * Read specified configuration file.
  *
  * @param {string} file Configuration file name.
  * @param {ConfigurationParser[] | ReadConfigCallback} parsers Parsing
  * function(s).
+ * @param {Object} [fs] File system implementation.
  * @param {ReadConfigCallback} [callback] Callback (err, result) function.
  * @returns {void}
  */
-function readConfig(file, parsers, callback) {
+function readConfig(file, parsers, fs, callback) {
   if (!callback) {
-    // @ts-ignore
-    callback = parsers;
-    parsers = null;
+    if (fs) {
+      callback = fs;
+      fs = null;
+    } else {
+      // @ts-ignore
+      callback = parsers;
+      parsers = null;
+    }
+  }
+  if (!fs) {
+    fs = require("fs");
   }
   // Read file
-  fs.readFile(file, helpers.utf8Encoding, (err, content) => {
+  fs.readFile(file, "utf8", (err, content) => {
     if (err) {
       return callback(err);
     }
@@ -924,33 +1024,43 @@ function readConfig(file, parsers, callback) {
     const configExtends = config.extends;
     if (configExtends) {
       delete config.extends;
-      const extendsFile = path.resolve(path.dirname(file), configExtends);
-      return readConfig(extendsFile, parsers, (errr, extendsConfig) => {
-        if (errr) {
-          return callback(errr);
-        }
-        return callback(null, {
-          ...extendsConfig,
-          ...config
-        });
-      });
+      return resolveConfigExtends(
+        file,
+        configExtends,
+        fs,
+        (_, resolvedExtends) => readConfig(
+          resolvedExtends,
+          parsers,
+          fs,
+          (errr, extendsConfig) => {
+            if (errr) {
+              return callback(errr);
+            }
+            return callback(null, {
+              ...extendsConfig,
+              ...config
+            });
+          }
+        )
+      );
     }
     return callback(null, config);
   });
 }
 
-const readConfigPromisify = util.promisify(readConfig);
+const readConfigPromisify = promisify && promisify(readConfig);
 
 /**
  * Read specified configuration file.
  *
  * @param {string} file Configuration file name.
  * @param {ConfigurationParser[]} [parsers] Parsing function(s).
+ * @param {Object} [fs] File system implementation.
  * @returns {Promise<Configuration>} Configuration object.
  */
-function readConfigPromise(file, parsers) {
+function readConfigPromise(file, parsers, fs) {
   // @ts-ignore
-  return readConfigPromisify(file, parsers);
+  return readConfigPromisify(file, parsers, fs);
 }
 
 /**
@@ -958,12 +1068,16 @@ function readConfigPromise(file, parsers) {
  *
  * @param {string} file Configuration file name.
  * @param {ConfigurationParser[]} [parsers] Parsing function(s).
+ * @param {Object} [fs] File system implementation.
  * @returns {Configuration} Configuration object.
+ * @throws An Error if processing fails.
  */
-function readConfigSync(file, parsers) {
+function readConfigSync(file, parsers, fs) {
+  if (!fs) {
+    fs = require("fs");
+  }
   // Read file
-  // @ts-ignore
-  const content = fs.readFileSync(file, helpers.utf8Encoding);
+  const content = fs.readFileSync(file, "utf8");
   // Try to parse file
   const { config, message } = parseConfiguration(file, content, parsers);
   if (!config) {
@@ -973,11 +1087,9 @@ function readConfigSync(file, parsers) {
   const configExtends = config.extends;
   if (configExtends) {
     delete config.extends;
+    const resolvedExtends = resolveConfigExtendsSync(file, configExtends, fs);
     return {
-      ...readConfigSync(
-        path.resolve(path.dirname(file), configExtends),
-        parsers
-      ),
+      ...readConfigSync(resolvedExtends, parsers, fs),
       ...config
     };
   }
@@ -1020,7 +1132,7 @@ module.exports = markdownlint;
  *
  * @typedef {Object} RuleParams
  * @property {string} name File/string name.
- * @property {MarkdownItToken[]} tokens markdown-it token objects.
+ * @property {MarkdownItToken[]} tokens Token objects from markdown-it.
  * @property {string[]} lines File/string lines.
  * @property {string[]} frontMatterLines Front matter lines.
  * @property {RuleConfiguration} config Rule configuration.
@@ -1100,10 +1212,11 @@ module.exports = markdownlint;
  * @property {boolean} [noInlineConfig] True to ignore HTML directives.
  * @property {number} [resultVersion] Results object version.
  * @property {Plugin[]} [markdownItPlugins] Additional plugins.
+ * @property {Object} [fs] File system implementation.
  */
 
 /**
- * markdown-it plugin.
+ * A markdown-it plugin.
  *
  * @typedef {Array} Plugin
  */
@@ -1134,20 +1247,21 @@ module.exports = markdownlint;
  * @property {string} errorDetail Detail about the error.
  * @property {string} errorContext Context for the error.
  * @property {number[]} errorRange Column number (1-based) and length.
- * @property {FixInfo} fixInfo Fix information.
+ * @property {FixInfo} [fixInfo] Fix information.
  */
 
 /**
  * Fix information.
  *
  * @typedef {Object} FixInfo
+ * @property {number} [lineNumber] Line number (1-based).
  * @property {number} [editColumn] Column of the fix (1-based).
  * @property {number} [deleteCount] Count of characters to delete.
  * @property {string} [insertText] Text to insert (after deleting).
  */
 
 /**
- * Called with the result of the lint operation.
+ * Called with the result of the lint function.
  *
  * @callback LintCallback
  * @param {Error | null} err Error object or null.
@@ -1177,10 +1291,19 @@ module.exports = markdownlint;
  */
 
 /**
- * Called with the result of the readConfig operation.
+ * Called with the result of the readConfig function.
  *
  * @callback ReadConfigCallback
  * @param {Error | null} err Error object or null.
  * @param {Configuration} [config] Configuration object.
  * @returns {void}
  */
+
+/**
+ * Called with the result of the resolveConfigExtends function.
+ *
+ * @callback ResolveConfigExtendsCallback
+ * @param {Error | null} err Error object or null.
+ * @param {string} [path] Resolved path to file.
+ * @returns {void}
+ */

package/lib/md002.js

@@ -6,7 +6,7 @@ const { addErrorDetailIf } = require("../helpers");
 
 module.exports = {
   "names": [ "MD002", "first-heading-h1", "first-header-h1" ],
-  "description": "First heading should be a top level heading",
+  "description": "First heading should be a top-level heading",
   "tags": [ "headings", "headers" ],
   "function": function MD002(params, onError) {
     const level = Number(params.config.level || 1);

package/lib/md004.js

@@ -2,10 +2,22 @@
 
 "use strict";
 
-const { addErrorDetailIf, listItemMarkerRe,
-  rangeFromRegExp, unorderedListStyleFor } = require("../helpers");
+const { addErrorDetailIf, listItemMarkerRe, unorderedListStyleFor } =
+  require("../helpers");
 const { flattenedLists } = require("./cache");
 
+const expectedStyleToMarker = {
+  "dash": "-",
+  "plus": "+",
+  "asterisk": "*"
+};
+const differentItemStyle = {
+  "dash": "plus",
+  "plus": "asterisk",
+  "asterisk": "dash"
+};
+const validStyles = Object.keys(expectedStyleToMarker);
+
 module.exports = {
   "names": [ "MD004", "ul-style" ],
   "description": "Unordered list style",
@@ -23,19 +35,40 @@ module.exports = {
           const itemStyle = unorderedListStyleFor(item);
           if (style === "sublist") {
             const nesting = list.nesting;
-            if (!nestingStyles[nesting] &&
-              (itemStyle !== nestingStyles[nesting - 1])) {
-              nestingStyles[nesting] = itemStyle;
-            } else {
-              addErrorDetailIf(onError, item.lineNumber,
-                nestingStyles[nesting], itemStyle, null, null,
-                rangeFromRegExp(item.line, listItemMarkerRe));
+            if (!nestingStyles[nesting]) {
+              nestingStyles[nesting] =
+                (itemStyle === nestingStyles[nesting - 1]) ?
+                  differentItemStyle[itemStyle] :
+                  itemStyle;
             }
-          } else {
-            addErrorDetailIf(onError, item.lineNumber,
-              expectedStyle, itemStyle, null, null,
-              rangeFromRegExp(item.line, listItemMarkerRe));
+            expectedStyle = nestingStyles[nesting];
+          }
+          if (!validStyles.includes(expectedStyle)) {
+            expectedStyle = validStyles[0];
+          }
+          let range = null;
+          let fixInfo = null;
+          const match = item.line.match(listItemMarkerRe);
+          if (match) {
+            const column = match.index + 1;
+            const length = match[0].length;
+            range = [ column, length ];
+            fixInfo = {
+              "editColumn": match[1].length + 1,
+              "deleteCount": 1,
+              "insertText": expectedStyleToMarker[expectedStyle]
+            };
           }
+          addErrorDetailIf(
+            onError,
+            item.lineNumber,
+            expectedStyle,
+            itemStyle,
+            null,
+            null,
+            range,
+            fixInfo
+          );
         });
       }
     });

package/lib/md006.js

@@ -25,7 +25,7 @@ module.exports = {
             null,
             rangeFromRegExp(line, listItemMarkerRe),
             {
-              "deleteCount": line.length - line.trimLeft().length
+              "deleteCount": line.length - line.trimStart().length
             });
         });
       }

package/lib/md009.js

@@ -47,30 +47,32 @@ module.exports = {
       codeInlineLineNumbers.sort(numericSortAscending);
     }
     const expected = (brSpaces < 2) ? 0 : brSpaces;
-    let inFencedCode = 0;
-    forEachLine(lineMetadata(), (line, lineIndex, inCode, onFence) => {
-      inFencedCode += onFence;
+    forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
       const lineNumber = lineIndex + 1;
-      const trailingSpaces = line.length - line.trimRight().length;
-      if ((!inCode || inFencedCode) && trailingSpaces &&
-        !includesSorted(listItemLineNumbers, lineNumber)) {
-        if ((expected !== trailingSpaces) ||
-            (strict &&
-             (!includesSorted(paragraphLineNumbers, lineNumber) ||
-              includesSorted(codeInlineLineNumbers, lineNumber)))) {
-          const column = line.length - trailingSpaces + 1;
-          addError(
-            onError,
-            lineNumber,
-            "Expected: " + (expected === 0 ? "" : "0 or ") +
-              expected + "; Actual: " + trailingSpaces,
-            null,
-            [ column, trailingSpaces ],
-            {
-              "editColumn": column,
-              "deleteCount": trailingSpaces
-            });
-        }
+      const trailingSpaces = line.length - line.trimEnd().length;
+      if (
+        trailingSpaces &&
+        !inCode &&
+        !includesSorted(listItemLineNumbers, lineNumber) &&
+        (
+          (expected !== trailingSpaces) ||
+          (strict &&
+            (!includesSorted(paragraphLineNumbers, lineNumber) ||
+             includesSorted(codeInlineLineNumbers, lineNumber)))
+        )
+      ) {
+        const column = line.length - trailingSpaces + 1;
+        addError(
+          onError,
+          lineNumber,
+          "Expected: " + (expected === 0 ? "" : "0 or ") +
+            expected + "; Actual: " + trailingSpaces,
+          null,
+          [ column, trailingSpaces ],
+          {
+            "editColumn": column,
+            "deleteCount": trailingSpaces
+          });
       }
     });
   }

package/lib/md010.js

@@ -14,6 +14,10 @@ module.exports = {
   "function": function MD010(params, onError) {
     const codeBlocks = params.config.code_blocks;
     const includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
+    const spacesPerTab = params.config.spaces_per_tab;
+    const spaceMultiplier = (spacesPerTab === undefined) ?
+      1 :
+      Math.max(0, Number(spacesPerTab));
     forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
       if (!inCode || includeCodeBlocks) {
         let match = null;
@@ -29,7 +33,7 @@ module.exports = {
             {
               "editColumn": column,
               "deleteCount": length,
-              "insertText": "".padEnd(length)
+              "insertText": "".padEnd(length * spaceMultiplier)
             });
         }
       }