markdownlint 0.37.4 → 0.38.0

package/lib/markdownlint.mjs

@@ -8,6 +8,7 @@ import { requireMarkdownItCjs } from "./defer-require.cjs";
 import { resolveModule } from "./resolve-module.cjs";
 import rules from "./rules.mjs";
 import { parse as micromarkParse } from "./micromark-parse.mjs";
+import parseConfiguration from "./parse-configuration.mjs";
 import * as helpers from "../helpers/helpers.cjs";
 
 /**
@@ -269,37 +270,13 @@ function getEffectiveConfig(ruleList, config, aliasToRuleNames) {
 }
 
 /**
- * Parse the content of a configuration file.
+ * Result object for getEnabledRulesPerLineNumber.
  *
- * @param {string} name Name of the configuration file.
- * @param {string} content Configuration content.
- * @param {ConfigurationParser[] | null} [parsers] Parsing function(s).
- * @returns {Object} Configuration object and error message.
+ * @typedef {Object} EnabledRulesPerLineNumberResult
+ * @property {Configuration} effectiveConfig Effective configuration.
+ * @property {any[]} enabledRulesPerLineNumber Enabled rules per line number.
+ * @property {Rule[]} enabledRuleList Enabled rule list.
  */
-function parseConfiguration(name, content, parsers) {
-  let config = null;
-  let message = "";
-  const errors = [];
-  let index = 0;
-  // Try each parser
-  (parsers || [ JSON.parse ]).every((parser) => {
-    try {
-      config = parser(content);
-    } catch (error) {
-      errors.push(`Parser ${index++}: ${error.message}`);
-    }
-    return !config;
-  });
-  // Message if unable to parse
-  if (!config) {
-    errors.unshift(`Unable to parse '${name}'`);
-    message = errors.join("; ");
-  }
-  return {
-    config,
-    message
-  };
-}
 
 /**
  * Create a mapping of enabled rules per line.
@@ -309,10 +286,10 @@ function parseConfiguration(name, content, parsers) {
  * @param {string[]} frontMatterLines List of front matter lines.
  * @param {boolean} noInlineConfig Whether to allow inline configuration.
  * @param {Configuration} config Configuration object.
- * @param {ConfigurationParser[] | null} configParsers Configuration parsers.
+ * @param {ConfigurationParser[] | undefined} configParsers Configuration parsers.
  * @param {Object.<string, string[]>} aliasToRuleNames Map of alias to rule
  * names.
- * @returns {Object} Effective configuration and enabled rules per line number.
+ * @returns {EnabledRulesPerLineNumberResult} Effective configuration and enabled rules per line number.
  */
 function getEnabledRulesPerLineNumber(
   ruleList,
@@ -443,17 +420,17 @@ function getEnabledRulesPerLineNumber(
  * Lints a string containing Markdown content.
  *
  * @param {Rule[]} ruleList List of rules.
- * @param {Object.<string, string[]>} aliasToRuleNames Map of alias to rule
- * names.
+ * @param {Object.<string, string[]>} aliasToRuleNames Map of alias to rule names.
  * @param {string} name Identifier for the content.
  * @param {string} content Markdown content.
- * @param {Plugin[]} markdownItPlugins Additional plugins.
+ * @param {MarkdownItFactory} markdownItFactory Function to create a markdown-it parser.
  * @param {Configuration} config Configuration object.
- * @param {ConfigurationParser[] | null} configParsers Configuration parsers.
+ * @param {ConfigurationParser[] | undefined} configParsers Configuration parsers.
  * @param {RegExp | null} 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 {boolean} synchronous Whether to execute synchronously.
  * @param {LintContentCallback} callback Callback (err, result) function.
  * @returns {void}
  */
@@ -462,14 +439,17 @@ function lintContent(
   aliasToRuleNames,
   name,
   content,
-  markdownItPlugins,
+  markdownItFactory,
   config,
   configParsers,
   frontMatter,
   handleRuleFailures,
   noInlineConfig,
   resultVersion,
+  synchronous,
   callback) {
+  // Provide a consistent error-reporting callback
+  const callbackError = (error) => callback(error instanceof Error ? error : new Error(error));
   // Remove UTF-8 byte order marker (if present)
   content = content.replace(/^\uFEFF/, "");
   // Remove front matter
@@ -490,263 +470,280 @@ function lintContent(
   const needMarkdownItTokens = enabledRuleList.some(
     (rule) => (rule.parser === "markdownit") || (rule.parser === undefined)
   );
+  const needMicromarkTokens = enabledRuleList.some(
+    (rule) => (rule.parser === "micromark")
+  );
   const customRulesPresent = (ruleList.length !== rules.length);
   // Parse content into parser tokens
-  const micromarkTokens = micromarkParse(
-    content,
-    { "freezeTokens": customRulesPresent }
-  );
+  const micromarkTokens = needMicromarkTokens ?
+    micromarkParse(content, { "freezeTokens": customRulesPresent }) :
+    [];
   // Hide the content of HTML comments from rules
   const preClearedContent = content;
   content = helpers.clearHtmlCommentText(content);
   // Parse content into lines and get markdown-it tokens
   const lines = content.split(helpers.newLineRe);
-  const markdownitTokens = needMarkdownItTokens ?
-    requireMarkdownItCjs().getMarkdownItTokens(markdownItPlugins, preClearedContent, lines) :
-    [];
-  // Create (frozen) parameters for rules
-  /** @type {MarkdownParsers} */
-  // @ts-ignore
-  const parsersMarkdownIt = Object.freeze({
-    "markdownit": Object.freeze({
-      "tokens": markdownitTokens
-    })
-  });
-  /** @type {MarkdownParsers} */
-  // @ts-ignore
-  const parsersMicromark = Object.freeze({
-    "micromark": Object.freeze({
-      "tokens": micromarkTokens
-    })
-  });
-  /** @type {MarkdownParsers} */
-  // @ts-ignore
-  const parsersNone = Object.freeze({});
-  const paramsBase = {
-    name,
-    version,
-    "lines": Object.freeze(lines),
-    "frontMatterLines": Object.freeze(frontMatterLines)
-  };
-  cacheInitialize({
-    ...paramsBase,
-    "parsers": parsersMicromark,
-    "config": null
-  });
-  // Function to run for each rule
-  let results = [];
-  /**
-   * @param {Rule} rule Rule.
-   * @returns {Promise<void> | null} Promise.
-   */
-  const forRule = (rule) => {
-    // Configure rule
-    const ruleName = rule.names[0].toUpperCase();
-    const tokens = {};
-    let parsers = parsersNone;
-    if (rule.parser === undefined) {
-      tokens.tokens = markdownitTokens;
-      parsers = parsersMarkdownIt;
-    } else if (rule.parser === "markdownit") {
-      parsers = parsersMarkdownIt;
-    } else if (rule.parser === "micromark") {
-      parsers = parsersMicromark;
-    }
-    const params = {
-      ...paramsBase,
-      ...tokens,
-      parsers,
-      "config": effectiveConfig[ruleName]
+  // Function to run after fetching markdown-it tokens (when needed)
+  const lintContentInternal = (markdownitTokens) => {
+    // Create (frozen) parameters for rules
+    /** @type {MarkdownParsers} */
+    // @ts-ignore
+    const parsersMarkdownIt = Object.freeze({
+      "markdownit": Object.freeze({
+        "tokens": markdownitTokens
+      })
+    });
+    /** @type {MarkdownParsers} */
+    // @ts-ignore
+    const parsersMicromark = Object.freeze({
+      "micromark": Object.freeze({
+        "tokens": micromarkTokens
+      })
+    });
+    /** @type {MarkdownParsers} */
+    // @ts-ignore
+    const parsersNone = Object.freeze({});
+    const paramsBase = {
+      name,
+      version,
+      "lines": Object.freeze(lines),
+      "frontMatterLines": Object.freeze(frontMatterLines)
     };
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    function throwError(property) {
-      throw new Error(
-        `Value of '${property}' passed to onError by '${ruleName}' is incorrect for '${name}'.`);
-    }
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    function onError(errorInfo) {
-      if (!errorInfo ||
-        !helpers.isNumber(errorInfo.lineNumber) ||
-        (errorInfo.lineNumber < 1) ||
-        (errorInfo.lineNumber > lines.length)) {
-        throwError("lineNumber");
-      }
-      const lineNumber = errorInfo.lineNumber + frontMatterLines.length;
-      if (!enabledRulesPerLineNumber[lineNumber][ruleName]) {
-        return;
-      }
-      if (errorInfo.detail &&
-        !helpers.isString(errorInfo.detail)) {
-        throwError("detail");
-      }
-      if (errorInfo.context &&
-        !helpers.isString(errorInfo.context)) {
-        throwError("context");
-      }
-      if (errorInfo.information &&
-        !helpers.isUrl(errorInfo.information)) {
-        throwError("information");
+    cacheInitialize({
+      ...paramsBase,
+      "parsers": parsersMicromark,
+      "config": null
+    });
+    // Function to run for each rule
+    let results = [];
+    /**
+     * @param {Rule} rule Rule.
+     * @returns {Promise<void> | null} Promise.
+     */
+    const forRule = (rule) => {
+      // Configure rule
+      const ruleName = rule.names[0].toUpperCase();
+      const tokens = {};
+      let parsers = parsersNone;
+      if (rule.parser === undefined) {
+        tokens.tokens = markdownitTokens;
+        parsers = parsersMarkdownIt;
+      } else if (rule.parser === "markdownit") {
+        parsers = parsersMarkdownIt;
+      } else if (rule.parser === "micromark") {
+        parsers = parsersMicromark;
       }
-      if (errorInfo.range &&
-        (!Array.isArray(errorInfo.range) ||
-          (errorInfo.range.length !== 2) ||
-          !helpers.isNumber(errorInfo.range[0]) ||
-          (errorInfo.range[0] < 1) ||
-          !helpers.isNumber(errorInfo.range[1]) ||
-          (errorInfo.range[1] < 1) ||
-          ((errorInfo.range[0] + errorInfo.range[1] - 1) >
-          lines[errorInfo.lineNumber - 1].length))) {
-        throwError("range");
+      const params = {
+        ...paramsBase,
+        ...tokens,
+        parsers,
+        "config": effectiveConfig[ruleName]
+      };
+      // eslint-disable-next-line jsdoc/require-jsdoc
+      function throwError(property) {
+        throw new Error(
+          `Value of '${property}' passed to onError by '${ruleName}' is incorrect for '${name}'.`);
       }
-      const fixInfo = errorInfo.fixInfo;
-      const cleanFixInfo = {};
-      if (fixInfo) {
-        if (!helpers.isObject(fixInfo)) {
-          throwError("fixInfo");
+      // eslint-disable-next-line jsdoc/require-jsdoc
+      function onError(errorInfo) {
+        if (!errorInfo ||
+          !helpers.isNumber(errorInfo.lineNumber) ||
+          (errorInfo.lineNumber < 1) ||
+          (errorInfo.lineNumber > lines.length)) {
+          throwError("lineNumber");
         }
-        if (fixInfo.lineNumber !== undefined) {
-          if ((!helpers.isNumber(fixInfo.lineNumber) ||
-            (fixInfo.lineNumber < 1) ||
-            (fixInfo.lineNumber > lines.length))) {
-            throwError("fixInfo.lineNumber");
-          }
-          cleanFixInfo.lineNumber =
-            fixInfo.lineNumber + frontMatterLines.length;
+        const lineNumber = errorInfo.lineNumber + frontMatterLines.length;
+        if (!enabledRulesPerLineNumber[lineNumber][ruleName]) {
+          return;
         }
-        const effectiveLineNumber = fixInfo.lineNumber || errorInfo.lineNumber;
-        if (fixInfo.editColumn !== undefined) {
-          if ((!helpers.isNumber(fixInfo.editColumn) ||
-            (fixInfo.editColumn < 1) ||
-            (fixInfo.editColumn >
-              lines[effectiveLineNumber - 1].length + 1))) {
-            throwError("fixInfo.editColumn");
-          }
-          cleanFixInfo.editColumn = fixInfo.editColumn;
+        if (errorInfo.detail &&
+          !helpers.isString(errorInfo.detail)) {
+          throwError("detail");
         }
-        if (fixInfo.deleteCount !== undefined) {
-          if ((!helpers.isNumber(fixInfo.deleteCount) ||
-            (fixInfo.deleteCount < -1) ||
-            (fixInfo.deleteCount >
-              lines[effectiveLineNumber - 1].length))) {
-            throwError("fixInfo.deleteCount");
-          }
-          cleanFixInfo.deleteCount = fixInfo.deleteCount;
+        if (errorInfo.context &&
+          !helpers.isString(errorInfo.context)) {
+          throwError("context");
+        }
+        if (errorInfo.information &&
+          !helpers.isUrl(errorInfo.information)) {
+          throwError("information");
         }
-        if (fixInfo.insertText !== undefined) {
-          if (!helpers.isString(fixInfo.insertText)) {
-            throwError("fixInfo.insertText");
+        if (errorInfo.range &&
+          (!Array.isArray(errorInfo.range) ||
+            (errorInfo.range.length !== 2) ||
+            !helpers.isNumber(errorInfo.range[0]) ||
+            (errorInfo.range[0] < 1) ||
+            !helpers.isNumber(errorInfo.range[1]) ||
+            (errorInfo.range[1] < 1) ||
+            ((errorInfo.range[0] + errorInfo.range[1] - 1) >
+            lines[errorInfo.lineNumber - 1].length))) {
+          throwError("range");
+        }
+        const fixInfo = errorInfo.fixInfo;
+        const cleanFixInfo = {};
+        if (fixInfo) {
+          if (!helpers.isObject(fixInfo)) {
+            throwError("fixInfo");
+          }
+          if (fixInfo.lineNumber !== undefined) {
+            if ((!helpers.isNumber(fixInfo.lineNumber) ||
+              (fixInfo.lineNumber < 1) ||
+              (fixInfo.lineNumber > lines.length))) {
+              throwError("fixInfo.lineNumber");
+            }
+            cleanFixInfo.lineNumber =
+              fixInfo.lineNumber + frontMatterLines.length;
+          }
+          const effectiveLineNumber = fixInfo.lineNumber || errorInfo.lineNumber;
+          if (fixInfo.editColumn !== undefined) {
+            if ((!helpers.isNumber(fixInfo.editColumn) ||
+              (fixInfo.editColumn < 1) ||
+              (fixInfo.editColumn >
+                lines[effectiveLineNumber - 1].length + 1))) {
+              throwError("fixInfo.editColumn");
+            }
+            cleanFixInfo.editColumn = fixInfo.editColumn;
+          }
+          if (fixInfo.deleteCount !== undefined) {
+            if ((!helpers.isNumber(fixInfo.deleteCount) ||
+              (fixInfo.deleteCount < -1) ||
+              (fixInfo.deleteCount >
+                lines[effectiveLineNumber - 1].length))) {
+              throwError("fixInfo.deleteCount");
+            }
+            cleanFixInfo.deleteCount = fixInfo.deleteCount;
+          }
+          if (fixInfo.insertText !== undefined) {
+            if (!helpers.isString(fixInfo.insertText)) {
+              throwError("fixInfo.insertText");
+            }
+            cleanFixInfo.insertText = fixInfo.insertText;
           }
-          cleanFixInfo.insertText = fixInfo.insertText;
         }
+        const information = errorInfo.information || rule.information;
+        results.push({
+          lineNumber,
+          "ruleName": rule.names[0],
+          "ruleNames": rule.names,
+          "ruleDescription": rule.description,
+          "ruleInformation": information ? information.href : null,
+          "errorDetail": errorInfo.detail || null,
+          "errorContext": errorInfo.context || null,
+          "errorRange": errorInfo.range ? [ ...errorInfo.range ] : null,
+          "fixInfo": fixInfo ? cleanFixInfo : null
+        });
       }
-      const information = errorInfo.information || rule.information;
-      results.push({
-        lineNumber,
-        "ruleName": rule.names[0],
-        "ruleNames": rule.names,
-        "ruleDescription": rule.description,
-        "ruleInformation": information ? information.href : null,
-        "errorDetail": errorInfo.detail || null,
-        "errorContext": errorInfo.context || null,
-        "errorRange": errorInfo.range ? [ ...errorInfo.range ] : null,
-        "fixInfo": fixInfo ? cleanFixInfo : null
+      // Call (possibly external) rule function to report errors
+      const catchCallsOnError = (error) => onError({
+        "lineNumber": 1,
+        "detail": `This rule threw an exception: ${error.message || error}`
       });
-    }
-    // Call (possibly external) rule function to report errors
-    const catchCallsOnError = (error) => onError({
-      "lineNumber": 1,
-      "detail": `This rule threw an exception: ${error.message || error}`
-    });
-    const invokeRuleFunction = () => rule.function(params, onError);
-    if (rule.asynchronous) {
-      // Asynchronous rule, ensure it returns a Promise
-      const ruleFunctionPromise =
-        Promise.resolve().then(invokeRuleFunction);
-      return handleRuleFailures ?
-        ruleFunctionPromise.catch(catchCallsOnError) :
-        ruleFunctionPromise;
-    }
-    // Synchronous rule
-    try {
-      invokeRuleFunction();
-    } catch (error) {
-      if (handleRuleFailures) {
-        catchCallsOnError(error);
-      } else {
-        throw error;
+      const invokeRuleFunction = () => rule.function(params, onError);
+      if (rule.asynchronous) {
+        // Asynchronous rule, ensure it returns a Promise
+        const ruleFunctionPromise =
+          Promise.resolve().then(invokeRuleFunction);
+        return handleRuleFailures ?
+          ruleFunctionPromise.catch(catchCallsOnError) :
+          ruleFunctionPromise;
       }
-    }
-    return null;
-  };
-  // eslint-disable-next-line jsdoc/require-jsdoc
-  function formatResults() {
-    // Sort results by rule name by line number
-    results.sort((a, b) => (
-      a.ruleName.localeCompare(b.ruleName) ||
-      a.lineNumber - b.lineNumber
-    ));
-    if (resultVersion < 3) {
-      // Remove fixInfo and multiple errors for the same rule and line number
-      const noPrevious = {
-        "ruleName": null,
-        "lineNumber": -1
-      };
-      results = results.filter((error, index, array) => {
-        delete error.fixInfo;
-        const previous = array[index - 1] || noPrevious;
-        return (
-          (error.ruleName !== previous.ruleName) ||
-          (error.lineNumber !== previous.lineNumber)
-        );
-      });
-    }
-    if (resultVersion === 0) {
-      // Return a dictionary of rule->[line numbers]
-      const dictionary = {};
-      for (const error of results) {
-        const ruleLines = dictionary[error.ruleName] || [];
-        ruleLines.push(error.lineNumber);
-        dictionary[error.ruleName] = ruleLines;
+      // Synchronous rule
+      try {
+        invokeRuleFunction();
+      } catch (error) {
+        if (handleRuleFailures) {
+          catchCallsOnError(error);
+        } else {
+          throw error;
+        }
       }
-      // @ts-ignore
-      results = dictionary;
-    } else if (resultVersion === 1) {
-      // Use ruleAlias instead of ruleNames
-      for (const error of results) {
-        error.ruleAlias = error.ruleNames[1] || error.ruleName;
-        delete error.ruleNames;
+      return null;
+    };
+    const formatResults = () => {
+      // Sort results by rule name by line number
+      results.sort((a, b) => (
+        a.ruleName.localeCompare(b.ruleName) ||
+        a.lineNumber - b.lineNumber
+      ));
+      if (resultVersion < 3) {
+        // Remove fixInfo and multiple errors for the same rule and line number
+        const noPrevious = {
+          "ruleName": null,
+          "lineNumber": -1
+        };
+        results = results.filter((error, index, array) => {
+          delete error.fixInfo;
+          const previous = array[index - 1] || noPrevious;
+          return (
+            (error.ruleName !== previous.ruleName) ||
+            (error.lineNumber !== previous.lineNumber)
+          );
+        });
       }
-    } else {
-      // resultVersion 2 or 3: Remove unwanted ruleName
-      for (const error of results) {
-        delete error.ruleName;
+      if (resultVersion === 0) {
+        // Return a dictionary of rule->[line numbers]
+        const dictionary = {};
+        for (const error of results) {
+          const ruleLines = dictionary[error.ruleName] || [];
+          ruleLines.push(error.lineNumber);
+          dictionary[error.ruleName] = ruleLines;
+        }
+        // @ts-ignore
+        results = dictionary;
+      } else if (resultVersion === 1) {
+        // Use ruleAlias instead of ruleNames
+        for (const error of results) {
+          error.ruleAlias = error.ruleNames[1] || error.ruleName;
+          delete error.ruleNames;
+        }
+      } else {
+        // resultVersion 2 or 3: Remove unwanted ruleName
+        for (const error of results) {
+          delete error.ruleName;
+        }
       }
+      return results;
+    };
+    // Run all rules
+    const ruleListAsync = enabledRuleList.filter((rule) => rule.asynchronous);
+    const ruleListSync = enabledRuleList.filter((rule) => !rule.asynchronous);
+    const ruleListAsyncFirst = [
+      ...ruleListAsync,
+      ...ruleListSync
+    ];
+    const callbackSuccess = () => callback(null, formatResults());
+    try {
+      const ruleResults = ruleListAsyncFirst.map(forRule);
+      if (ruleListAsync.length > 0) {
+        Promise.all(ruleResults.slice(0, ruleListAsync.length))
+          .then(callbackSuccess)
+          .catch(callbackError);
+      } else {
+        callbackSuccess();
+      }
+    } catch (error) {
+      callbackError(error);
+    } finally {
+      cacheInitialize();
     }
-    return results;
-  }
-  // Run all rules
-  const ruleListAsync = enabledRuleList.filter((rule) => rule.asynchronous);
-  const ruleListSync = enabledRuleList.filter((rule) => !rule.asynchronous);
-  const ruleListAsyncFirst = [
-    ...ruleListAsync,
-    ...ruleListSync
-  ];
-  const callbackSuccess = () => callback(null, formatResults());
-  const callbackError =
-    (error) => callback(error instanceof Error ? error : new Error(error));
-  try {
-    const ruleResults = ruleListAsyncFirst.map(forRule);
-    if (ruleListAsync.length > 0) {
-      Promise.all(ruleResults.slice(0, ruleListAsync.length))
-        .then(callbackSuccess)
-        .catch(callbackError);
-    } else {
-      callbackSuccess();
-    }
-  } catch (error) {
-    callbackError(error);
-  } finally {
-    cacheInitialize();
+  };
+  if (!needMarkdownItTokens || synchronous) {
+    // Need/able to call into markdown-it and lintContentInternal synchronously
+    const markdownItTokens = needMarkdownItTokens ?
+      requireMarkdownItCjs().getMarkdownItTokens(markdownItFactory(), preClearedContent, lines) :
+      [];
+    lintContentInternal(markdownItTokens);
+  } else {
+    // Need to call into markdown-it and lintContentInternal asynchronously
+    Promise.all([
+      // eslint-disable-next-line no-inline-comments
+      import(/* webpackMode: "eager" */ "./markdownit.cjs"),
+      // eslint-disable-next-line no-promise-executor-return
+      new Promise((resolve) => resolve(markdownItFactory()))
+    ]).then(([ markdownitCjs, markdownIt ]) => {
+      const markdownItTokens = markdownitCjs.getMarkdownItTokens(markdownIt, preClearedContent, lines);
+      lintContentInternal(markdownItTokens);
+    }).catch(callbackError);
   }
 }
 
@@ -754,12 +751,11 @@ function lintContent(
  * Lints a file containing Markdown content.
  *
  * @param {Rule[]} ruleList List of rules.
- * @param {Object.<string, string[]>} aliasToRuleNames Map of alias to rule
- * names.
+ * @param {Object.<string, string[]>} aliasToRuleNames Map of alias to rule names.
  * @param {string} file Path of file to lint.
- * @param {Plugin[]} markdownItPlugins Additional plugins.
+ * @param {MarkdownItFactory} markdownItFactory Function to create a markdown-it parser.
  * @param {Configuration} config Configuration object.
- * @param {ConfigurationParser[] | null} configParsers Configuration parsers.
+ * @param {ConfigurationParser[] | undefined} configParsers Configuration parsers.
  * @param {RegExp | null} frontMatter Regular expression for front matter.
  * @param {boolean} handleRuleFailures Whether to handle exceptions in rules.
  * @param {boolean} noInlineConfig Whether to allow inline configuration.
@@ -773,7 +769,7 @@ function lintFile(
   ruleList,
   aliasToRuleNames,
   file,
-  markdownItPlugins,
+  markdownItFactory,
   config,
   configParsers,
   frontMatter,
@@ -793,13 +789,14 @@ function lintFile(
       aliasToRuleNames,
       file,
       content,
-      markdownItPlugins,
+      markdownItFactory,
       config,
       configParsers,
       frontMatter,
       handleRuleFailures,
       noInlineConfig,
       resultVersion,
+      synchronous,
       callback
     );
   }
@@ -851,7 +848,7 @@ function lintInput(options, synchronous, callback) {
   const strings = options.strings || {};
   const stringsKeys = Object.keys(strings);
   const config = options.config || { "default": true };
-  const configParsers = options.configParsers || null;
+  const configParsers = options.configParsers || undefined;
   const frontMatter = (options.frontMatter === undefined) ?
     helpers.frontMatterRe :
     options.frontMatter;
@@ -860,7 +857,9 @@ function lintInput(options, synchronous, callback) {
   const resultVersion = (options.resultVersion === undefined) ?
     3 :
     options.resultVersion;
-  const markdownItPlugins = options.markdownItPlugins || [];
+  const markdownItFactory =
+    options.markdownItFactory ||
+    (() => { throw new Error("The option 'markdownItFactory' was required (due to the option 'customRules' including a rule requiring the 'markdown-it' parser), but 'markdownItFactory' was not set."); });
   const fs = options.fs || nodeFs;
   const aliasToRuleNames = mapAliasToRuleNames(ruleList);
   const results = newResults(ruleList);
@@ -892,7 +891,7 @@ function lintInput(options, synchronous, callback) {
         ruleList,
         aliasToRuleNames,
         currentItem,
-        markdownItPlugins,
+        markdownItFactory,
         config,
         configParsers,
         frontMatter,
@@ -911,13 +910,14 @@ function lintInput(options, synchronous, callback) {
         aliasToRuleNames,
         currentItem,
         strings[currentItem] || "",
-        markdownItPlugins,
+        markdownItFactory,
         config,
         configParsers,
         frontMatter,
         handleRuleFailures,
         noInlineConfig,
         resultVersion,
+        synchronous,
         lintWorkerCallback
       );
     } else if (concurrency === 0) {
@@ -1194,6 +1194,7 @@ export function readConfigSync(file, parsers, fs) {
   // Try to parse file
   const { config, message } = parseConfiguration(file, content, parsers);
   if (!config) {
+    // @ts-ignore
     throw new Error(message);
   }
   // Extend configuration
@@ -1473,6 +1474,29 @@ export function getVersion() {
  * @property {RuleFunction} function Rule implementation.
  */
 
+/**
+ * Method used by the markdown-it parser to parse input.
+ *
+ * @callback MarkdownItParse
+ * @param {string} src Source string.
+ * @param {Object} env Environment sandbox.
+ * @returns {import("markdown-it").Token[]} Tokens.
+ */
+
+/**
+ * Instance of the markdown-it parser.
+ *
+ * @typedef MarkdownIt
+ * @property {MarkdownItParse} parse Method to parse input.
+ */
+
+/**
+ * Gets an instance of the markdown-it parser. Any plugins should already have been loaded.
+ *
+ * @callback MarkdownItFactory
+ * @returns {MarkdownIt|Promise<MarkdownIt>} Instance of the markdown-it parser.
+ */
+
 /**
  * Configuration options.
  *
@@ -1484,7 +1508,7 @@ export function getVersion() {
  * @property {RegExp | null} [frontMatter] Front matter pattern.
  * @property {Object} [fs] File system implementation.
  * @property {boolean} [handleRuleFailures] True to catch exceptions.
- * @property {Plugin[]} [markdownItPlugins] Additional plugins.
+ * @property {MarkdownItFactory} [markdownItFactory] Function to create a markdown-it parser.
  * @property {boolean} [noInlineConfig] True to ignore HTML directives.
  * @property {number} [resultVersion] Results object version.
  * @property {Object.<string, string>} [strings] Strings to lint.
@@ -1501,7 +1525,7 @@ export function getVersion() {
  *
  * @callback ToStringCallback
  * @param {boolean} [ruleAliases] True to use rule aliases.
- * @returns {string}
+ * @returns {string} Pretty-printed results.
  */
 
 /**