markdownlint 0.40.0 → 0.41.1

package/lib/constants.mjs

@@ -8,7 +8,7 @@ export const fixableRuleNames = [
   "MD022", "MD023", "MD026", "MD027", "MD029", "MD030",
   "MD031", "MD032", "MD034", "MD037", "MD038", "MD039",
   "MD044", "MD047", "MD049", "MD050", "MD051", "MD053",
-  "MD054", "MD058"
+  "MD054", "MD058", "MD060"
 ];
 export const homepage = "https://github.com/DavidAnson/markdownlint";
-export const version = "0.40.0";
+export const version = "0.41.1";

package/lib/exports.d.mts

@@ -9,6 +9,7 @@ export type LintContentCallback = import("./markdownlint.mjs").LintContentCallba
 export type LintError = import("./markdownlint.mjs").LintError;
 export type LintResults = import("./markdownlint.mjs").LintResults;
 export type MarkdownItFactory = import("./markdownlint.mjs").MarkdownItFactory;
+export type MarkdownItBaseToken = import("./markdownlint.mjs").MarkdownItBaseToken;
 export type MarkdownItToken = import("./markdownlint.mjs").MarkdownItToken;
 export type MarkdownParsers = import("./markdownlint.mjs").MarkdownParsers;
 export type MicromarkToken = import("./markdownlint.mjs").MicromarkToken;

package/lib/exports.mjs

@@ -13,6 +13,7 @@ export { resolveModule } from "./resolve-module.cjs";
 /** @typedef {import("./markdownlint.mjs").LintError} LintError */
 /** @typedef {import("./markdownlint.mjs").LintResults} LintResults */
 /** @typedef {import("./markdownlint.mjs").MarkdownItFactory} MarkdownItFactory */
+/** @typedef {import("./markdownlint.mjs").MarkdownItBaseToken} MarkdownItBaseToken */
 /** @typedef {import("./markdownlint.mjs").MarkdownItToken} MarkdownItToken */
 /** @typedef {import("./markdownlint.mjs").MarkdownParsers} MarkdownParsers */
 /** @typedef {import("./markdownlint.mjs").MicromarkToken} MicromarkToken */

package/lib/markdownit.cjs

@@ -2,10 +2,11 @@
 
 "use strict";
 
-const { newLineRe } = require("../helpers");
+const { newlineRe } = require("../helpers/shared.cjs");
 
 // @ts-expect-error https://github.com/microsoft/TypeScript/issues/52529
 /** @typedef {import("markdownlint").MarkdownIt} MarkdownIt */
+/** @typedef {import("markdownlint").MarkdownItBaseToken} MarkdownItBaseToken */
 /** @typedef {import("markdownlint").MarkdownItToken} MarkdownItToken */
 /** @typedef {import("markdownlint").Plugin} Plugin */
 
@@ -34,7 +35,7 @@ function forEachInlineCodeSpan(input, handler) {
     backticksLengthAndIndex.push([ match[0].length, match.index ]);
   }
   const newLinesIndex = [];
-  while ((match = newLineRe.exec(input)) !== null) {
+  while ((match = newlineRe.exec(input)) !== null) {
     newLinesIndex.push(match.index);
   }
   let lineIndex = 0;
@@ -47,12 +48,12 @@ function forEachInlineCodeSpan(input, handler) {
         const [ endLength, endIndex ] = backticksLengthAndIndex[j];
         if (startLength === endLength) {
           for (; k < newLinesIndex.length; k++) {
-            const newLineIndex = newLinesIndex[k];
-            if (startIndex < newLineIndex) {
+            const newlineIndex = newLinesIndex[k];
+            if (startIndex < newlineIndex) {
               break;
             }
             lineIndex++;
-            lineStartIndex = newLineIndex + 1;
+            lineStartIndex = newlineIndex + 1;
           }
           const columnIndex = startIndex - lineStartIndex + startLength;
           handler(
@@ -97,7 +98,7 @@ function freezeToken(token) {
 /**
  * Annotate tokens with line/lineNumber and freeze them.
  *
- * @param {import("markdown-it").Token[]} tokens Array of markdown-it tokens.
+ * @param {MarkdownItBaseToken[]} tokens Array of markdown-it tokens.
  * @param {string[]} lines Lines of Markdown content.
  * @returns {void}
  */
@@ -131,7 +132,7 @@ function annotateAndFreezeTokens(tokens, lines) {
       const codeSpanExtraLines = [];
       if (token.children.some((child) => child.type === "code_inline")) {
         forEachInlineCodeSpan(token.content, (code) => {
-          codeSpanExtraLines.push(code.split(newLineRe).length - 1);
+          codeSpanExtraLines.push(code.split(newlineRe).length - 1);
         });
       }
       let lineNumber = token.lineNumber;

package/lib/markdownlint.d.mts

@@ -218,13 +218,13 @@ export type ParserMicromark = {
     tokens: MicromarkToken[];
 };
 /**
- * markdown-it token.
+ * markdown-it base token.
  */
-export type MarkdownItToken = {
+export type MarkdownItBaseToken = {
     /**
      * HTML attributes.
      */
-    attrs: string[][];
+    attrs: string[][] | null;
     /**
      * Block-level token.
      */
@@ -232,7 +232,7 @@ export type MarkdownItToken = {
     /**
      * Child nodes.
      */
-    children: MarkdownItToken[];
+    children: MarkdownItBaseToken[] | null;
     /**
      * Tag contents.
      */
@@ -252,7 +252,7 @@ export type MarkdownItToken = {
     /**
      * Beginning/ending line numbers.
      */
-    map: number[];
+    map: number[] | null;
     /**
      * Markup text.
      */
@@ -260,7 +260,7 @@ export type MarkdownItToken = {
     /**
      * Arbitrary data.
      */
-    meta: any;
+    meta: Object;
     /**
      * Level change.
      */
@@ -273,6 +273,15 @@ export type MarkdownItToken = {
      * Token type.
      */
     type: string;
+};
+/**
+ * markdown-it extended token.
+ */
+export type MarkdownItExtendedToken = {
+    /**
+     * Child nodes.
+     */
+    children: MarkdownItExtendedToken[] | null;
     /**
      * Line number (1-based).
      */
@@ -282,6 +291,10 @@ export type MarkdownItToken = {
      */
     line: string;
 };
+/**
+ * markdown-it token.
+ */
+export type MarkdownItToken = MarkdownItBaseToken & MarkdownItExtendedToken;
 export type MicromarkTokenType = import("micromark-util-types").TokenType;
 /**
  * micromark token.
@@ -335,23 +348,23 @@ export type RuleOnErrorInfo = {
     /**
      * Detail about the error.
      */
-    detail?: string;
+    detail?: string | undefined;
     /**
      * Context for the error.
      */
-    context?: string;
+    context?: string | undefined;
     /**
      * Link to more information.
      */
-    information?: URL;
+    information?: URL | undefined;
     /**
      * Column number (1-based) and length.
      */
-    range?: number[];
+    range?: number[] | undefined;
     /**
      * Fix information.
      */
-    fixInfo?: RuleOnErrorFixInfo;
+    fixInfo?: RuleOnErrorFixInfo | undefined;
 };
 /**
  * Fix information for RuleOnErrorInfo.
@@ -360,19 +373,19 @@ export type RuleOnErrorFixInfo = {
     /**
      * Line number (1-based).
      */
-    lineNumber?: number;
+    lineNumber?: number | undefined;
     /**
      * Column of the fix (1-based).
      */
-    editColumn?: number;
+    editColumn?: number | undefined;
     /**
      * Count of characters to delete.
      */
-    deleteCount?: number;
+    deleteCount?: number | undefined;
     /**
      * Text to insert (after deleting).
      */
-    insertText?: string;
+    insertText?: string | undefined;
 };
 /**
  * Rule definition.
@@ -389,7 +402,7 @@ export type Rule = {
     /**
      * Link to more information.
      */
-    information?: URL;
+    information?: URL | undefined;
     /**
      * Rule tag(s).
      */
@@ -401,7 +414,7 @@ export type Rule = {
     /**
      * True if asynchronous.
      */
-    asynchronous?: boolean;
+    asynchronous?: boolean | undefined;
     /**
      * Rule implementation.
      */
@@ -410,7 +423,7 @@ export type Rule = {
 /**
  * Method used by the markdown-it parser to parse input.
  */
-export type MarkdownItParse = (src: string, env: any) => any[];
+export type MarkdownItParse = (src: string, env: Object) => MarkdownItBaseToken[];
 /**
  * Instance of the markdown-it parser.
  */
@@ -431,50 +444,50 @@ export type Options = {
     /**
      * Configuration object.
      */
-    config?: Configuration;
+    config?: import("./configuration.d.ts").Configuration | undefined;
     /**
      * Configuration parsers.
      */
-    configParsers?: ConfigurationParser[];
+    configParsers?: ConfigurationParser[] | undefined;
     /**
      * Custom rules.
      */
-    customRules?: Rule[] | Rule;
+    customRules?: Rule | Rule[] | undefined;
     /**
      * Files to lint.
      */
-    files?: string[] | string;
+    files?: string | string[] | undefined;
     /**
      * Front matter pattern.
      */
-    frontMatter?: RegExp | null;
+    frontMatter?: RegExp | null | undefined;
     /**
      * File system implementation.
      */
-    fs?: FsLike;
+    fs?: FsLike | undefined;
     /**
      * True to catch exceptions.
      */
-    handleRuleFailures?: boolean;
+    handleRuleFailures?: boolean | undefined;
     /**
      * Function to create a markdown-it parser.
      */
-    markdownItFactory?: MarkdownItFactory;
+    markdownItFactory?: MarkdownItFactory | undefined;
     /**
      * True to ignore HTML directives.
      */
-    noInlineConfig?: boolean;
+    noInlineConfig?: boolean | undefined;
     /**
      * Strings to lint.
      */
     strings?: {
         [x: string]: string;
-    };
+    } | undefined;
 };
 /**
  * A markdown-it plugin.
  */
-export type Plugin = any[];
+export type Plugin = Object[];
 /**
  * Lint results.
  */
@@ -529,19 +542,19 @@ export type FixInfo = {
     /**
      * Line number (1-based).
      */
-    lineNumber?: number;
+    lineNumber?: number | undefined;
     /**
      * Column of the fix (1-based).
      */
-    editColumn?: number;
+    editColumn?: number | undefined;
     /**
      * Count of characters to delete.
      */
-    deleteCount?: number;
+    deleteCount?: number | undefined;
     /**
      * Text to insert (after deleting).
      */
-    insertText?: string;
+    insertText?: string | undefined;
 };
 /**
  * FixInfo with all optional properties present.
@@ -567,11 +580,13 @@ export type FixInfoNormalized = {
 /**
  * Called with the result of linting a string or document.
  */
-export type LintContentCallback = (error: Error | null, result?: LintError[]) => void;
+export type LintContentCallback = (error: Error | null, result?: LintError[] | undefined) => void;
 /**
  * Called with the result of the lint function.
  */
-export type LintCallback = (error: Error | null, results?: LintResults) => void;
+export type LintCallback = (error: Error | null, results?: {
+    [x: string]: LintError[];
+} | undefined) => void;
 /**
  * Configuration object for linting rules. For the JSON schema, see
  * {@link  ../schema/markdownlint-config-schema.json}.
@@ -582,10 +597,6 @@ export type Configuration = import("./configuration.d.ts").Configuration;
  * {@link  ../schema/markdownlint-config-schema-strict.json}.
  */
 export type ConfigurationStrict = import("./configuration-strict.d.ts").ConfigurationStrict;
-/**
- * Rule configuration.
- */
-export type RuleConfiguration = boolean | any;
 /**
  * Parses a configuration string and returns a configuration object.
  */
@@ -593,8 +604,12 @@ export type ConfigurationParser = (text: string) => Configuration;
 /**
  * Called with the result of the readConfig function.
  */
-export type ReadConfigCallback = (err: Error | null, config?: Configuration) => void;
+export type ReadConfigCallback = (err: Error | null, config?: import("./configuration.d.ts").Configuration | undefined) => void;
 /**
  * Called with the result of the resolveConfigExtends function.
  */
-export type ResolveConfigExtendsCallback = (err: Error | null, path?: string) => void;
+export type ResolveConfigExtendsCallback = (err: Error | null, path?: string | undefined) => void;
+/**
+ * Rule configuration.
+ */
+export type RuleConfiguration = boolean | any;

package/lib/markdownlint.mjs

@@ -93,6 +93,7 @@ function validateRuleList(ruleList, synchronous) {
       }
       for (const tag of rule.tags) {
         const tagUpper = tag.toUpperCase();
+        // eslint-disable-next-line unicorn/no-computed-property-existence-check
         if (!result && allIds[tagUpper]) {
           result = new Error("Tag '" + tag + "' of custom rule at index " +
             customIndex + " is already used as a name.");
@@ -104,81 +105,6 @@ function validateRuleList(ruleList, synchronous) {
   return result;
 }
 
-/**
- * Creates a LintResults instance with toString for pretty display.
- *
- * @param {Rule[]} ruleList List of rules.
- * @returns {LintResults} New LintResults instance.
- */
-function newResults(ruleList) {
-  /**
-   * Returns the string representation of a LintResults instance.
-   *
-   * @param {boolean} useAlias True if rule alias should be used instead of name.
-   * @returns {string} String representation of the instance.
-   * @this {LintResults}
-   */
-  function toString(useAlias) {
-    // eslint-disable-next-line consistent-this, unicorn/no-this-assignment
-    const lintResults = this;
-    /** @type {Object.<string, Rule> | null} */
-    let ruleNameToRule = null;
-    const results = [];
-    const keys = Object.keys(lintResults);
-    keys.sort();
-    for (const file of keys) {
-      const fileResults = lintResults[file];
-      if (Array.isArray(fileResults)) {
-        for (const result of fileResults) {
-          const ruleMoniker = result.ruleNames ?
-            result.ruleNames.join("/") :
-            // @ts-ignore
-            (result.ruleName + "/" + result.ruleAlias);
-          results.push(
-            file + ": " +
-            result.lineNumber + ": " +
-            ruleMoniker + " " +
-            result.ruleDescription +
-            (result.errorDetail ?
-              " [" + result.errorDetail + "]" :
-              "") +
-            (result.errorContext ?
-              " [Context: \"" + result.errorContext + "\"]" :
-              ""));
-        }
-      } else {
-        if (!ruleNameToRule) {
-          ruleNameToRule = {};
-          for (const rule of ruleList) {
-            const ruleName = rule.names[0].toUpperCase();
-            ruleNameToRule[ruleName] = rule;
-          }
-        }
-        for (const [ ruleName, ruleResults ] of Object.entries(fileResults)) {
-          const rule = ruleNameToRule[ruleName.toUpperCase()];
-          for (const lineNumber of ruleResults) {
-            // @ts-ignore
-            const nameIndex = Math.min(useAlias ? 1 : 0, rule.names.length - 1);
-            const result =
-              file + ": " +
-              lineNumber + ": " +
-              // @ts-ignore
-              rule.names[nameIndex] + " " +
-              // @ts-ignore
-              rule.description;
-            results.push(result);
-          }
-        }
-      }
-    }
-    return results.join("\n");
-  }
-  const lintResults = {};
-  Object.defineProperty(lintResults, "toString", { "value": toString });
-  // @ts-ignore
-  return lintResults;
-}
-
 /**
  * Result object for removeFrontMatter.
  *
@@ -273,6 +199,7 @@ function getEffectiveConfig(ruleList, config, aliasToRuleNames) {
   let ruleDefaultEnable = true;
   /** @type {"error" | "warning"} */
   let ruleDefaultSeverity = "error";
+  // eslint-disable-next-line unicorn/no-unused-array-method-return
   Object.entries(config).every(([ key, value ]) => {
     if (key.toUpperCase() === "DEFAULT") {
       ruleDefaultEnable = !!value;
@@ -513,6 +440,7 @@ function lintContent(
   // eslint-disable-next-line jsdoc/reject-any-type
   const callbackError = (/** @type {any} */ error) => callback(error instanceof Error ? error : new Error(error));
   // Remove UTF-8 byte order marker (if present)
+  // eslint-disable-next-line unicorn/prefer-unicode-code-point-escapes
   content = content.replace(/^\uFEFF/, "");
   // Remove front matter
   const removeFrontMatterResult = removeFrontMatter(content, frontMatter);
@@ -574,7 +502,7 @@ function lintContent(
     cacheInitialize({
       ...paramsBase,
       "parsers": parsersMicromark,
-      "config": null
+      "config": {}
     });
     // Function to run for each rule
     /** @type {LintError[]} */
@@ -845,8 +773,8 @@ function lintFile(
  */
 function lintInput(options, synchronous, callback) {
   // Normalize inputs
-  options = options || {};
-  callback = callback || function noop() {};
+  options ||= {};
+  callback ||= () => {};
   /** @type {Rule[]} */
   // @ts-ignore
   const customRuleList =
@@ -884,9 +812,6 @@ function lintInput(options, synchronous, callback) {
     options.frontMatter;
   const handleRuleFailures = !!options.handleRuleFailures;
   const noInlineConfig = !!options.noInlineConfig;
-  // @ts-ignore
-  // eslint-disable-next-line dot-notation
-  const resultVersion = (options["resultVersion"] === undefined) ? 3 : options["resultVersion"];
   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."); });
@@ -894,7 +819,7 @@ function lintInput(options, synchronous, callback) {
   // @ts-ignore
   const fs = options.fs || nodeFs;
   const aliasToRuleNames = mapAliasToRuleNames(ruleList);
-  const results = newResults(ruleList);
+  const results = {};
   let done = false;
   let concurrency = 0;
   // eslint-disable-next-line jsdoc/require-jsdoc
@@ -952,18 +877,12 @@ function lintInput(options, synchronous, callback) {
         lintWorkerCallback
       );
     } else if (concurrency === 0) {
-      // Finish
+      // Finished, sort keys for consistency
       done = true;
-      // Deprecated: Convert results to specified resultVersion
-      let convertedResults = results;
-      if (resultVersion === 0) {
-        convertedResults = helpers.convertToResultVersion0(results);
-      } else if (resultVersion === 1) {
-        convertedResults = helpers.convertToResultVersion1(results);
-      } else if (resultVersion === 2) {
-        convertedResults = helpers.convertToResultVersion2(results);
-      }
-      return callback(null, convertedResults);
+      const sortedEntries = Object.entries(results);
+      sortedEntries.sort(([ a ], [ b ]) => a.localeCompare(b));
+      const sortedResults = Object.fromEntries(sortedEntries);
+      return callback(null, sortedResults);
     }
     return null;
   }
@@ -1292,6 +1211,7 @@ export function applyFix(line, fixInfo, lineEnding = "\n") {
   const editIndex = editColumn - 1;
   return (deleteCount === -1) ?
     null :
+    // eslint-disable-next-line unicorn/no-unsafe-string-replacement
     line.slice(0, editIndex) + insertText.replace(/\n/g, lineEnding) + line.slice(editIndex + deleteCount);
 }
 
@@ -1430,26 +1350,39 @@ export function getVersion() {
  */
 
 /**
- * markdown-it token.
+ * markdown-it base token.
  *
- * @typedef {Object} MarkdownItToken
- * @property {string[][]} attrs HTML attributes.
+ * @typedef {Object} MarkdownItBaseToken
+ * @property {string[][] | null} attrs HTML attributes.
  * @property {boolean} block Block-level token.
- * @property {MarkdownItToken[]} children Child nodes.
+ * @property {MarkdownItBaseToken[] | null} children Child nodes.
  * @property {string} content Tag contents.
  * @property {boolean} hidden Ignore element.
  * @property {string} info Fence info.
  * @property {number} level Nesting level.
- * @property {number[]} map Beginning/ending line numbers.
+ * @property {number[] | null} map Beginning/ending line numbers.
  * @property {string} markup Markup text.
  * @property {Object} meta Arbitrary data.
  * @property {number} nesting Level change.
  * @property {string} tag HTML tag name.
  * @property {string} type Token type.
+ */
+
+/**
+ * markdown-it extended token.
+ *
+ * @typedef {Object} MarkdownItExtendedToken
+ * @property {MarkdownItExtendedToken[] | null} children Child nodes.
  * @property {number} lineNumber Line number (1-based).
  * @property {string} line Line content.
  */
 
+/**
+ * markdown-it token.
+ *
+ * @typedef {MarkdownItBaseToken & MarkdownItExtendedToken} MarkdownItToken
+ */
+
 /** @typedef {import("micromark-util-types").TokenType} MicromarkTokenType */
 
 /**
@@ -1515,7 +1448,7 @@ export function getVersion() {
  * @callback MarkdownItParse
  * @param {string} src Source string.
  * @param {Object} env Environment sandbox.
- * @returns {import("markdown-it").Token[]} Tokens.
+ * @returns {MarkdownItBaseToken[]} Tokens.
  */
 
 /**
@@ -1627,12 +1560,6 @@ export function getVersion() {
  * @typedef {import("./configuration-strict.d.ts").ConfigurationStrict} ConfigurationStrict
  */
 
-/**
- * Rule configuration object.
- *
- * @typedef {boolean | Object} RuleConfiguration Rule configuration.
- */
-
 /**
  * Parses a configuration string and returns a configuration object.
  *
@@ -1658,3 +1585,11 @@ export function getVersion() {
  * @param {string} [path] Resolved path to file.
  * @returns {void}
  */
+
+/* eslint-disable jsdoc/reject-any-type */
+
+/**
+ * Rule configuration object.
+ *
+ * @typedef {boolean | any} RuleConfiguration Rule configuration.
+ */

package/lib/md004.mjs

@@ -40,6 +40,7 @@ export default {
       for (const listItemMarker of listItemMarkers) {
         const itemStyle = markerToStyle(listItemMarker.text);
         if (style === "sublist") {
+          // eslint-disable-next-line unicorn/no-computed-property-existence-check
           if (!nestingStyles[nesting]) {
             nestingStyles[nesting] =
               (itemStyle === nestingStyles[nesting - 1]) ?

package/lib/md005.mjs

@@ -34,7 +34,7 @@ export default {
         } else {
           const markerLength = listItemPrefix.text.trim().length;
           const actualEnd = listItemPrefix.startColumn + markerLength - 1;
-          expectedEnd = expectedEnd || actualEnd;
+          expectedEnd ||= actualEnd;
           if ((expectedIndent !== actualIndent) || endMatching) {
             if (expectedEnd === actualEnd) {
               endMatching = true;

package/lib/md019-md021.mjs

@@ -16,6 +16,7 @@ function validateHeadingSpaces(onError, heading, delta) {
   const { children, startLine, text } = heading;
   let index = (delta > 0) ? 0 : (children.length - 1);
   while (
+    // eslint-disable-next-line unicorn/no-computed-property-existence-check
     children[index] &&
     (children[index].type !== "atxHeadingSequence")
   ) {