markdownlint 0.37.4 → 0.38.0

package/lib/constants.mjs

@@ -10,4 +10,4 @@ export const fixableRuleNames = [
   "MD058"
 ];
 export const homepage = "https://github.com/DavidAnson/markdownlint";
-export const version = "0.37.4";
+export const version = "0.38.0";

package/lib/exports.d.mts

@@ -7,6 +7,7 @@ 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;

package/lib/exports.mjs

@@ -11,6 +11,7 @@ export { resolveModule } from "./resolve-module.cjs";
 /** @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 */

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}
  */
@@ -152,21 +152,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

@@ -82,6 +82,23 @@ export function applyFixes(input: string, errors: RuleOnErrorInfo[]): string;
  * @returns {string} SemVer string.
  */
 export function getVersion(): string;
+/**
+ * Result object for getEnabledRulesPerLineNumber.
+ */
+export type EnabledRulesPerLineNumberResult = {
+    /**
+     * Effective configuration.
+     */
+    effectiveConfig: Configuration;
+    /**
+     * Enabled rules per line number.
+     */
+    enabledRulesPerLineNumber: any[];
+    /**
+     * Enabled rule list.
+     */
+    enabledRuleList: Rule[];
+};
 /**
  * Function to implement rule logic.
  */
@@ -357,6 +374,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.
  */
@@ -390,9 +424,9 @@ export type Options = {
      */
     handleRuleFailures?: boolean;
     /**
-     * Additional plugins.
+     * Function to create a markdown-it parser.
      */
-    markdownItPlugins?: Plugin[];
+    markdownItFactory?: MarkdownItFactory;
     /**
      * True to ignore HTML directives.
      */