markdownlint 0.37.4 → 0.39.0

package/lib/constants.mjs

@@ -1,13 +1,14 @@
 // @ts-check
 
+/** @type {string[]} */
 export const deprecatedRuleNames = [];
 export const fixableRuleNames = [
   "MD004", "MD005", "MD007", "MD009", "MD010", "MD011",
   "MD012", "MD014", "MD018", "MD019", "MD020", "MD021",
-  "MD022", "MD023", "MD026", "MD027", "MD030", "MD031",
-  "MD032", "MD034", "MD037", "MD038", "MD039", "MD044",
-  "MD047", "MD049", "MD050", "MD051", "MD053", "MD054",
-  "MD058"
+  "MD022", "MD023", "MD026", "MD027", "MD029", "MD030",
+  "MD031", "MD032", "MD034", "MD037", "MD038", "MD039",
+  "MD044", "MD047", "MD049", "MD050", "MD051", "MD053",
+  "MD054", "MD058"
 ];
 export const homepage = "https://github.com/DavidAnson/markdownlint";
-export const version = "0.37.4";
+export const version = "0.39.0";

package/lib/defer-require.cjs

@@ -2,6 +2,8 @@
 
 "use strict";
 
+/* eslint-disable jsdoc/reject-any-type */
+
 /**
  * Calls require for markdownit.cjs. Used to synchronously defer loading because module.createRequire is buggy under webpack (https://github.com/webpack/webpack/issues/16724).
  *

package/lib/exports.d.mts

@@ -3,10 +3,12 @@ export type Configuration = import("./markdownlint.mjs").Configuration;
 export type ConfigurationParser = import("./markdownlint.mjs").ConfigurationParser;
 export type ConfigurationStrict = import("./markdownlint.mjs").ConfigurationStrict;
 export type FixInfo = import("./markdownlint.mjs").FixInfo;
+export type FixInfoNormalized = import("./markdownlint.mjs").FixInfoNormalized;
 export type LintCallback = import("./markdownlint.mjs").LintCallback;
 export type LintContentCallback = import("./markdownlint.mjs").LintContentCallback;
 export type LintError = import("./markdownlint.mjs").LintError;
 export type LintResults = import("./markdownlint.mjs").LintResults;
+export type MarkdownItFactory = import("./markdownlint.mjs").MarkdownItFactory;
 export type MarkdownItToken = import("./markdownlint.mjs").MarkdownItToken;
 export type MarkdownParsers = import("./markdownlint.mjs").MarkdownParsers;
 export type MicromarkToken = import("./markdownlint.mjs").MicromarkToken;
@@ -22,8 +24,6 @@ export type RuleConfiguration = import("./markdownlint.mjs").RuleConfiguration;
 export type RuleFunction = import("./markdownlint.mjs").RuleFunction;
 export type RuleOnError = import("./markdownlint.mjs").RuleOnError;
 export type RuleOnErrorFixInfo = import("./markdownlint.mjs").RuleOnErrorFixInfo;
-export type RuleOnErrorFixInfoNormalized = import("./markdownlint.mjs").RuleOnErrorFixInfoNormalized;
 export type RuleOnErrorInfo = import("./markdownlint.mjs").RuleOnErrorInfo;
 export type RuleParams = import("./markdownlint.mjs").RuleParams;
-export type ToStringCallback = import("./markdownlint.mjs").ToStringCallback;
 export { applyFix, applyFixes, getVersion } from "./markdownlint.mjs";

package/lib/exports.mjs

@@ -7,10 +7,12 @@ export { resolveModule } from "./resolve-module.cjs";
 /** @typedef {import("./markdownlint.mjs").ConfigurationParser} ConfigurationParser */
 /** @typedef {import("./markdownlint.mjs").ConfigurationStrict} ConfigurationStrict */
 /** @typedef {import("./markdownlint.mjs").FixInfo} FixInfo */
+/** @typedef {import("./markdownlint.mjs").FixInfoNormalized} FixInfoNormalized */
 /** @typedef {import("./markdownlint.mjs").LintCallback} LintCallback */
 /** @typedef {import("./markdownlint.mjs").LintContentCallback} LintContentCallback */
 /** @typedef {import("./markdownlint.mjs").LintError} LintError */
 /** @typedef {import("./markdownlint.mjs").LintResults} LintResults */
+/** @typedef {import("./markdownlint.mjs").MarkdownItFactory} MarkdownItFactory */
 /** @typedef {import("./markdownlint.mjs").MarkdownItToken} MarkdownItToken */
 /** @typedef {import("./markdownlint.mjs").MarkdownParsers} MarkdownParsers */
 /** @typedef {import("./markdownlint.mjs").MicromarkToken} MicromarkToken */
@@ -26,7 +28,5 @@ export { resolveModule } from "./resolve-module.cjs";
 /** @typedef {import("./markdownlint.mjs").RuleFunction} RuleFunction */
 /** @typedef {import("./markdownlint.mjs").RuleOnError} RuleOnError */
 /** @typedef {import("./markdownlint.mjs").RuleOnErrorFixInfo} RuleOnErrorFixInfo */
-/** @typedef {import("./markdownlint.mjs").RuleOnErrorFixInfoNormalized} RuleOnErrorFixInfoNormalized */
 /** @typedef {import("./markdownlint.mjs").RuleOnErrorInfo} RuleOnErrorInfo */
 /** @typedef {import("./markdownlint.mjs").RuleParams} RuleParams */
-/** @typedef {import("./markdownlint.mjs").ToStringCallback} ToStringCallback */

package/lib/markdownit.cjs

@@ -5,8 +5,8 @@
 const { newLineRe } = require("../helpers");
 
 // @ts-expect-error https://github.com/microsoft/TypeScript/issues/52529
+/** @typedef {import("markdownlint").MarkdownIt} MarkdownIt */
 /** @typedef {import("markdownlint").MarkdownItToken} MarkdownItToken */
-// @ts-expect-error https://github.com/microsoft/TypeScript/issues/52529
 /** @typedef {import("markdownlint").Plugin} Plugin */
 
 /**
@@ -97,7 +97,7 @@ function freezeToken(token) {
 /**
  * Annotate tokens with line/lineNumber and freeze them.
  *
- * @param {Object[]} tokens Array of markdown-it tokens.
+ * @param {import("markdown-it").Token[]} tokens Array of markdown-it tokens.
  * @param {string[]} lines Lines of Markdown content.
  * @returns {void}
  */
@@ -127,6 +127,7 @@ function annotateAndFreezeTokens(tokens, lines) {
     }
     // Annotate children with lineNumber
     if (token.children) {
+      /** @type {number[]} */
       const codeSpanExtraLines = [];
       if (token.children.some((child) => child.type === "code_inline")) {
         forEachInlineCodeSpan(token.content, (code) => {
@@ -140,7 +141,7 @@ function annotateAndFreezeTokens(tokens, lines) {
         if ((child.type === "softbreak") || (child.type === "hardbreak")) {
           lineNumber++;
         } else if (child.type === "code_inline") {
-          lineNumber += codeSpanExtraLines.shift();
+          lineNumber += codeSpanExtraLines.shift() || 0;
         }
       }
     }
@@ -152,21 +153,14 @@ function annotateAndFreezeTokens(tokens, lines) {
 /**
  * Gets an array of markdown-it tokens for the input.
  *
- * @param {Plugin[]} markdownItPlugins Additional plugins.
+ * @param {MarkdownIt} markdownIt Instance of the markdown-it parser.
  * @param {string} content Markdown content.
  * @param {string[]} lines Lines of Markdown content.
- * @returns {MarkdownItToken} Array of markdown-it tokens.
+ * @returns {MarkdownItToken[]} Array of markdown-it tokens.
  */
-function getMarkdownItTokens(markdownItPlugins, content, lines) {
-  const markdownit = require("markdown-it");
-  const md = markdownit({ "html": true });
-  for (const plugin of markdownItPlugins) {
-    // @ts-ignore
-    md.use(...plugin);
-  }
-  const tokens = md.parse(content, {});
+function getMarkdownItTokens(markdownIt, content, lines) {
+  const tokens = markdownIt.parse(content, {});
   annotateAndFreezeTokens(tokens, lines);
-  // @ts-ignore
   return tokens;
 };
 

package/lib/markdownlint.d.mts

@@ -26,62 +26,133 @@ export function lintSync(options: Options | null): LintResults;
  * @param {Configuration} config Configuration object.
  * @param {string} file Configuration file name.
  * @param {ConfigurationParser[] | undefined} parsers Parsing function(s).
- * @param {Object} fs File system implementation.
+ * @param {FsLike} fs File system implementation.
  * @returns {Promise<Configuration>} Configuration object.
  */
-export function extendConfigPromise(config: Configuration, file: string, parsers: ConfigurationParser[] | undefined, fs: any): Promise<Configuration>;
+export function extendConfigPromise(config: Configuration, file: string, parsers: ConfigurationParser[] | undefined, fs: FsLike): Promise<Configuration>;
 /**
  * Read specified configuration file.
  *
  * @param {string} file Configuration file name.
- * @param {ConfigurationParser[] | ReadConfigCallback} [parsers] Parsing
- * function(s).
- * @param {Object} [fs] File system implementation.
+ * @param {ConfigurationParser[] | ReadConfigCallback} [parsers] Parsing function(s).
+ * @param {FsLike | ReadConfigCallback} [fs] File system implementation.
  * @param {ReadConfigCallback} [callback] Callback (err, result) function.
  * @returns {void}
  */
-export function readConfigAsync(file: string, parsers?: ConfigurationParser[] | ReadConfigCallback, fs?: any, callback?: ReadConfigCallback): void;
+export function readConfigAsync(file: string, parsers?: ConfigurationParser[] | ReadConfigCallback, fs?: FsLike | ReadConfigCallback, callback?: ReadConfigCallback): void;
 /**
  * Read specified configuration file.
  *
  * @param {string} file Configuration file name.
  * @param {ConfigurationParser[]} [parsers] Parsing function(s).
- * @param {Object} [fs] File system implementation.
+ * @param {FsLike} [fs] File system implementation.
  * @returns {Promise<Configuration>} Configuration object.
  */
-export function readConfigPromise(file: string, parsers?: ConfigurationParser[], fs?: any): Promise<Configuration>;
+export function readConfigPromise(file: string, parsers?: ConfigurationParser[], fs?: FsLike): Promise<Configuration>;
 /**
  * Read specified configuration file.
  *
  * @param {string} file Configuration file name.
  * @param {ConfigurationParser[]} [parsers] Parsing function(s).
- * @param {Object} [fs] File system implementation.
+ * @param {FsLike} [fs] File system implementation.
  * @returns {Configuration} Configuration object.
  */
-export function readConfigSync(file: string, parsers?: ConfigurationParser[], fs?: any): Configuration;
+export function readConfigSync(file: string, parsers?: ConfigurationParser[], fs?: FsLike): Configuration;
 /**
  * Applies the specified fix to a Markdown content line.
  *
  * @param {string} line Line of Markdown content.
- * @param {RuleOnErrorFixInfo} fixInfo RuleOnErrorFixInfo instance.
+ * @param {FixInfo} fixInfo FixInfo instance.
  * @param {string} [lineEnding] Line ending to use.
  * @returns {string | null} Fixed content or null if deleted.
  */
-export function applyFix(line: string, fixInfo: RuleOnErrorFixInfo, lineEnding?: string): string | null;
+export function applyFix(line: string, fixInfo: FixInfo, lineEnding?: string): string | null;
 /**
  * Applies as many of the specified fixes as possible to Markdown content.
  *
  * @param {string} input Lines of Markdown content.
- * @param {RuleOnErrorInfo[]} errors RuleOnErrorInfo instances.
+ * @param {LintError[]} errors LintError instances.
  * @returns {string} Fixed content.
  */
-export function applyFixes(input: string, errors: RuleOnErrorInfo[]): string;
+export function applyFixes(input: string, errors: LintError[]): string;
 /**
  * Gets the (semantic) version of the library.
  *
  * @returns {string} SemVer string.
  */
 export function getVersion(): string;
+/**
+ * Result object for removeFrontMatter.
+ */
+export type RemoveFrontMatterResult = {
+    /**
+     * Markdown content.
+     */
+    content: string;
+    /**
+     * Front matter lines.
+     */
+    frontMatterLines: string[];
+};
+/**
+ * Result object for getEffectiveConfig.
+ */
+export type GetEffectiveConfigResult = {
+    /**
+     * Effective configuration.
+     */
+    effectiveConfig: Configuration;
+    /**
+     * Rules enabled.
+     */
+    rulesEnabled: Map<string, boolean>;
+    /**
+     * Rules severity.
+     */
+    rulesSeverity: Map<string, "error" | "warning">;
+};
+/**
+ * Result object for getEnabledRulesPerLineNumber.
+ */
+export type EnabledRulesPerLineNumberResult = {
+    /**
+     * Effective configuration.
+     */
+    effectiveConfig: Configuration;
+    /**
+     * Enabled rules per line number.
+     */
+    enabledRulesPerLineNumber: Map<string, boolean>[];
+    /**
+     * Enabled rule list.
+     */
+    enabledRuleList: Rule[];
+    /**
+     * Rules severity.
+     */
+    rulesSeverity: Map<string, "error" | "warning">;
+};
+/**
+ * Node fs instance (or compatible object).
+ */
+export type FsLike = {
+    /**
+     * access method.
+     */
+    access: (path: string, callback: (err: Error) => void) => void;
+    /**
+     * accessSync method.
+     */
+    accessSync: (path: string) => void;
+    /**
+     * readFile method.
+     */
+    readFile: (path: string, encoding: string, callback: (err: Error, data: string) => void) => void;
+    /**
+     * readFileSync method.
+     */
+    readFileSync: (path: string, encoding: string) => string;
+};
 /**
  * Function to implement rule logic.
  */
@@ -303,27 +374,6 @@ export type RuleOnErrorFixInfo = {
      */
     insertText?: string;
 };
-/**
- * RuleOnErrorInfo with all optional properties present.
- */
-export type RuleOnErrorFixInfoNormalized = {
-    /**
-     * Line number (1-based).
-     */
-    lineNumber: number;
-    /**
-     * Column of the fix (1-based).
-     */
-    editColumn: number;
-    /**
-     * Count of characters to delete.
-     */
-    deleteCount: number;
-    /**
-     * Text to insert (after deleting).
-     */
-    insertText: string;
-};
 /**
  * Rule definition.
  */
@@ -357,6 +407,23 @@ export type Rule = {
      */
     function: RuleFunction;
 };
+/**
+ * Method used by the markdown-it parser to parse input.
+ */
+export type MarkdownItParse = (src: string, env: any) => any[];
+/**
+ * Instance of the markdown-it parser.
+ */
+export type MarkdownIt = {
+    /**
+     * Method to parse input.
+     */
+    parse: MarkdownItParse;
+};
+/**
+ * Gets an instance of the markdown-it parser. Any plugins should already have been loaded.
+ */
+export type MarkdownItFactory = () => MarkdownIt | Promise<MarkdownIt>;
 /**
  * Configuration options.
  */
@@ -384,23 +451,19 @@ export type Options = {
     /**
      * File system implementation.
      */
-    fs?: any;
+    fs?: FsLike;
     /**
      * True to catch exceptions.
      */
     handleRuleFailures?: boolean;
     /**
-     * Additional plugins.
+     * Function to create a markdown-it parser.
      */
-    markdownItPlugins?: Plugin[];
+    markdownItFactory?: MarkdownItFactory;
     /**
      * True to ignore HTML directives.
      */
     noInlineConfig?: boolean;
-    /**
-     * Results object version.
-     */
-    resultVersion?: number;
     /**
      * Strings to lint.
      */
@@ -413,11 +476,7 @@ export type Options = {
  */
 export type Plugin = any[];
 /**
- * Function to pretty-print lint results.
- */
-export type ToStringCallback = (ruleAliases?: boolean) => string;
-/**
- * Lint results (for resultVersion 3).
+ * Lint results.
  */
 export type LintResults = {
     [x: string]: LintError[];
@@ -441,23 +500,27 @@ export type LintError = {
     /**
      * Link to more information.
      */
-    ruleInformation: string;
+    ruleInformation: string | null;
     /**
      * Detail about the error.
      */
-    errorDetail: string;
+    errorDetail: string | null;
     /**
      * Context for the error.
      */
-    errorContext: string;
+    errorContext: string | null;
     /**
      * Column number (1-based) and length.
      */
-    errorRange: number[];
+    errorRange: number[] | null;
     /**
      * Fix information.
      */
-    fixInfo?: FixInfo;
+    fixInfo: FixInfo | null;
+    /**
+     * Severity of the error.
+     */
+    severity: "error" | "warning";
 };
 /**
  * Fix information.
@@ -480,6 +543,27 @@ export type FixInfo = {
      */
     insertText?: string;
 };
+/**
+ * FixInfo with all optional properties present.
+ */
+export type FixInfoNormalized = {
+    /**
+     * Line number (1-based).
+     */
+    lineNumber: number;
+    /**
+     * Column of the fix (1-based).
+     */
+    editColumn: number;
+    /**
+     * Count of characters to delete.
+     */
+    deleteCount: number;
+    /**
+     * Text to insert (after deleting).
+     */
+    insertText: string;
+};
 /**
  * Called with the result of linting a string or document.
  */