markdownlint 0.36.1 → 0.37.0

package/lib/configuration.d.ts

@@ -1,4 +1,4 @@
-import { ConfigurationStrict } from "./configuration-strict";
+import type { ConfigurationStrict } from "./configuration-strict.d.ts";
 
 export interface Configuration extends ConfigurationStrict {
   /**

package/lib/{constants.js → constants.mjs}

@@ -1,9 +1,7 @@
 // @ts-check
 
-"use strict";
-
-module.exports.deprecatedRuleNames = [];
-module.exports.fixableRuleNames = [
+export const deprecatedRuleNames = [];
+export const fixableRuleNames = [
   "MD004", "MD005", "MD007", "MD009", "MD010", "MD011",
   "MD012", "MD014", "MD018", "MD019", "MD020", "MD021",
   "MD022", "MD023", "MD026", "MD027", "MD030", "MD031",
@@ -11,5 +9,5 @@ module.exports.fixableRuleNames = [
   "MD047", "MD049", "MD050", "MD051", "MD053", "MD054",
   "MD058"
 ];
-module.exports.homepage = "https://github.com/DavidAnson/markdownlint";
-module.exports.version = "0.36.1";
+export const homepage = "https://github.com/DavidAnson/markdownlint";
+export const version = "0.37.0";

package/lib/exports-async.d.mts

@@ -0,0 +1 @@
+export { lintAsync as lint, readConfigAsync as readConfig } from "./markdownlint.mjs";

package/lib/exports-async.mjs

@@ -0,0 +1,3 @@
+// @ts-check
+
+export { lintAsync as lint, readConfigAsync as readConfig } from "./markdownlint.mjs";

package/lib/exports-promise.d.mts

@@ -0,0 +1 @@
+export { extendConfigPromise as extendConfig, lintPromise as lint, readConfigPromise as readConfig } from "./markdownlint.mjs";

package/lib/exports-promise.mjs

@@ -0,0 +1,3 @@
+// @ts-check
+
+export { extendConfigPromise as extendConfig, lintPromise as lint, readConfigPromise as readConfig } from "./markdownlint.mjs";

package/lib/exports-sync.d.mts

@@ -0,0 +1 @@
+export { lintSync as lint, readConfigSync as readConfig } from "./markdownlint.mjs";

package/lib/exports-sync.mjs

@@ -0,0 +1,3 @@
+// @ts-check
+
+export { lintSync as lint, readConfigSync as readConfig } from "./markdownlint.mjs";

package/lib/exports.d.mts

@@ -0,0 +1,28 @@
+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 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 MarkdownItToken = import("./markdownlint.mjs").MarkdownItToken;
+export type MarkdownParsers = import("./markdownlint.mjs").MarkdownParsers;
+export type MicromarkToken = import("./markdownlint.mjs").MicromarkToken;
+export type MicromarkTokenType = import("./markdownlint.mjs").MicromarkTokenType;
+export type Options = import("./markdownlint.mjs").Options;
+export type ParserMarkdownIt = import("./markdownlint.mjs").ParserMarkdownIt;
+export type ParserMicromark = import("./markdownlint.mjs").ParserMicromark;
+export type Plugin = import("./markdownlint.mjs").Plugin;
+export type ReadConfigCallback = import("./markdownlint.mjs").ReadConfigCallback;
+export type ResolveConfigExtendsCallback = import("./markdownlint.mjs").ResolveConfigExtendsCallback;
+export type Rule = import("./markdownlint.mjs").Rule;
+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

@@ -0,0 +1,31 @@
+// @ts-check
+
+export { applyFix, applyFixes, getVersion } from "./markdownlint.mjs";
+
+/** @typedef {import("./markdownlint.mjs").Configuration} Configuration */
+/** @typedef {import("./markdownlint.mjs").ConfigurationParser} ConfigurationParser */
+/** @typedef {import("./markdownlint.mjs").ConfigurationStrict} ConfigurationStrict */
+/** @typedef {import("./markdownlint.mjs").FixInfo} FixInfo */
+/** @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").MarkdownItToken} MarkdownItToken */
+/** @typedef {import("./markdownlint.mjs").MarkdownParsers} MarkdownParsers */
+/** @typedef {import("./markdownlint.mjs").MicromarkToken} MicromarkToken */
+/** @typedef {import("./markdownlint.mjs").MicromarkTokenType} MicromarkTokenType */
+/** @typedef {import("./markdownlint.mjs").Options} Options */
+/** @typedef {import("./markdownlint.mjs").ParserMarkdownIt} ParserMarkdownIt */
+/** @typedef {import("./markdownlint.mjs").ParserMicromark} ParserMicromark */
+/** @typedef {import("./markdownlint.mjs").Plugin} Plugin */
+/** @typedef {import("./markdownlint.mjs").ReadConfigCallback} ReadConfigCallback */
+/** @typedef {import("./markdownlint.mjs").ResolveConfigExtendsCallback} ResolveConfigExtendsCallback */
+/** @typedef {import("./markdownlint.mjs").Rule} Rule */
+/** @typedef {import("./markdownlint.mjs").RuleConfiguration} RuleConfiguration */
+/** @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

@@ -4,6 +4,11 @@
 
 const { newLineRe } = require("../helpers");
 
+// @ts-expect-error https://github.com/microsoft/TypeScript/issues/52529
+/** @typedef {import("markdownlint").MarkdownItToken} MarkdownItToken */
+// @ts-expect-error https://github.com/microsoft/TypeScript/issues/52529
+/** @typedef {import("markdownlint").Plugin} Plugin */
+
 /**
  * @callback InlineCodeSpanCallback
  * @param {string} code Code content.
@@ -67,7 +72,7 @@ function forEachInlineCodeSpan(input, handler) {
 /**
  * Freeze all freeze-able members of a token and its children.
  *
- * @param {import("./markdownlint").MarkdownItToken} token A markdown-it token.
+ * @param {MarkdownItToken} token A markdown-it token.
  * @returns {void}
  */
 function freezeToken(token) {
@@ -98,8 +103,7 @@ function freezeToken(token) {
  */
 function annotateAndFreezeTokens(tokens, lines) {
   let trMap = null;
-  // eslint-disable-next-line jsdoc/valid-types
-  /** @type import("./markdownlint").MarkdownItToken[] */
+  /** @type {MarkdownItToken[]} */
   // @ts-ignore
   const markdownItTokens = tokens;
   for (const token of markdownItTokens) {
@@ -148,10 +152,10 @@ function annotateAndFreezeTokens(tokens, lines) {
 /**
  * Gets an array of markdown-it tokens for the input.
  *
- * @param {import("./markdownlint").Plugin[]} markdownItPlugins Additional plugins.
+ * @param {Plugin[]} markdownItPlugins Additional plugins.
  * @param {string} content Markdown content.
  * @param {string[]} lines Lines of Markdown content.
- * @returns {import("../lib/markdownlint").MarkdownItToken} Array of markdown-it tokens.
+ * @returns {MarkdownItToken} Array of markdown-it tokens.
  */
 function getMarkdownItTokens(markdownItPlugins, content, lines) {
   const markdownit = require("markdown-it");

package/lib/{markdownlint.d.ts → markdownlint.d.mts}

@@ -1,4 +1,3 @@
-export = markdownlint;
 /**
  * Lint specified Markdown files.
  *
@@ -6,49 +5,60 @@ export = markdownlint;
  * @param {LintCallback} callback Callback (err, result) function.
  * @returns {void}
  */
-declare function markdownlint(options: Options | null, callback: LintCallback): void;
-declare namespace markdownlint {
-    export { markdownlintSync as sync, readConfig, readConfigSync, getVersion, promises, applyFix, applyFixes, RuleFunction, RuleParams, MarkdownParsers, ParserMarkdownIt, ParserMicromark, MarkdownItToken, MicromarkTokenType, MicromarkToken, RuleOnError, RuleOnErrorInfo, RuleOnErrorFixInfo, RuleOnErrorFixInfoNormalized, Rule, Options, Plugin, ToStringCallback, LintResults, LintError, FixInfo, LintContentCallback, LintCallback, Configuration, ConfigurationStrict, RuleConfiguration, ConfigurationParser, ReadConfigCallback, ResolveConfigExtendsCallback };
-}
+export function lintAsync(options: Options | null, callback: LintCallback): void;
 /**
- * Lint specified Markdown files synchronously.
+ * Lint specified Markdown files.
+ *
+ * @param {Options | null} options Configuration options.
+ * @returns {Promise<LintResults>} Results object.
+ */
+export function lintPromise(options: Options | null): Promise<LintResults>;
+/**
+ * Lint specified Markdown files.
  *
  * @param {Options | null} options Configuration options.
  * @returns {LintResults} Results object.
  */
-declare function markdownlintSync(options: Options | null): LintResults;
+export function lintSync(options: Options | null): LintResults;
+/**
+ * Extend specified configuration object.
+ *
+ * @param {Configuration} config Configuration object.
+ * @param {string} file Configuration file name.
+ * @param {ConfigurationParser[] | undefined} parsers Parsing function(s).
+ * @param {Object} fs File system implementation.
+ * @returns {Promise<Configuration>} Configuration object.
+ */
+export function extendConfigPromise(config: Configuration, file: string, parsers: ConfigurationParser[] | undefined, fs: any): Promise<Configuration>;
 /**
  * Read specified configuration file.
  *
  * @param {string} file Configuration file name.
- * @param {ConfigurationParser[] | ReadConfigCallback} parsers Parsing
+ * @param {ConfigurationParser[] | ReadConfigCallback} [parsers] Parsing
  * function(s).
  * @param {Object} [fs] File system implementation.
  * @param {ReadConfigCallback} [callback] Callback (err, result) function.
  * @returns {void}
  */
-declare function readConfig(file: string, parsers: ConfigurationParser[] | ReadConfigCallback, fs?: any, callback?: ReadConfigCallback): void;
+export function readConfigAsync(file: string, parsers?: ConfigurationParser[] | ReadConfigCallback, fs?: any, callback?: ReadConfigCallback): void;
 /**
- * Read specified configuration file synchronously.
+ * Read specified configuration file.
  *
  * @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.
+ * @returns {Promise<Configuration>} Configuration object.
  */
-declare function readConfigSync(file: string, parsers?: ConfigurationParser[], fs?: any): Configuration;
+export function readConfigPromise(file: string, parsers?: ConfigurationParser[], fs?: any): Promise<Configuration>;
 /**
- * Gets the (semantic) version of the library.
+ * Read specified configuration file.
  *
- * @returns {string} SemVer string.
+ * @param {string} file Configuration file name.
+ * @param {ConfigurationParser[]} [parsers] Parsing function(s).
+ * @param {Object} [fs] File system implementation.
+ * @returns {Configuration} Configuration object.
  */
-declare function getVersion(): string;
-declare namespace promises {
-    export { markdownlintPromise as markdownlint };
-    export { extendConfigPromise as extendConfig };
-    export { readConfigPromise as readConfig };
-}
+export function readConfigSync(file: string, parsers?: ConfigurationParser[], fs?: any): Configuration;
 /**
  * Applies the specified fix to a Markdown content line.
  *
@@ -57,7 +67,7 @@ declare namespace promises {
  * @param {string} [lineEnding] Line ending to use.
  * @returns {string | null} Fixed content or null if deleted.
  */
-declare function applyFix(line: string, fixInfo: RuleOnErrorFixInfo, lineEnding?: string): string | null;
+export function applyFix(line: string, fixInfo: RuleOnErrorFixInfo, lineEnding?: string): string | null;
 /**
  * Applies as many of the specified fixes as possible to Markdown content.
  *
@@ -65,15 +75,21 @@ declare function applyFix(line: string, fixInfo: RuleOnErrorFixInfo, lineEnding?
  * @param {RuleOnErrorInfo[]} errors RuleOnErrorInfo instances.
  * @returns {string} Fixed content.
  */
-declare function applyFixes(input: string, errors: RuleOnErrorInfo[]): string;
+export function applyFixes(input: string, errors: RuleOnErrorInfo[]): string;
+/**
+ * Gets the (semantic) version of the library.
+ *
+ * @returns {string} SemVer string.
+ */
+export function getVersion(): string;
 /**
  * Function to implement rule logic.
  */
-type RuleFunction = (params: RuleParams, onError: RuleOnError) => void;
+export type RuleFunction = (params: RuleParams, onError: RuleOnError) => void;
 /**
  * Rule parameters.
  */
-type RuleParams = {
+export type RuleParams = {
     /**
      * File/string name.
      */
@@ -102,7 +118,7 @@ type RuleParams = {
 /**
  * Markdown parser data.
  */
-type MarkdownParsers = {
+export type MarkdownParsers = {
     /**
      * Markdown parser data from markdown-it (only present when Rule.parser is "markdownit").
      */
@@ -115,7 +131,7 @@ type MarkdownParsers = {
 /**
  * Markdown parser data from markdown-it.
  */
-type ParserMarkdownIt = {
+export type ParserMarkdownIt = {
     /**
      * Token objects from markdown-it.
      */
@@ -124,7 +140,7 @@ type ParserMarkdownIt = {
 /**
  * Markdown parser data from micromark.
  */
-type ParserMicromark = {
+export type ParserMicromark = {
     /**
      * Token objects from micromark.
      */
@@ -133,7 +149,7 @@ type ParserMicromark = {
 /**
  * markdown-it token.
  */
-type MarkdownItToken = {
+export type MarkdownItToken = {
     /**
      * HTML attributes.
      */
@@ -195,11 +211,11 @@ type MarkdownItToken = {
      */
     line: string;
 };
-type MicromarkTokenType = import("markdownlint-micromark").TokenType;
+export type MicromarkTokenType = import("micromark-util-types").TokenType;
 /**
  * micromark token.
  */
-type MicromarkToken = {
+export type MicromarkToken = {
     /**
      * Token type.
      */
@@ -236,11 +252,11 @@ type MicromarkToken = {
 /**
  * Error-reporting callback.
  */
-type RuleOnError = (onErrorInfo: RuleOnErrorInfo) => void;
+export type RuleOnError = (onErrorInfo: RuleOnErrorInfo) => void;
 /**
  * Fix information for RuleOnError callback.
  */
-type RuleOnErrorInfo = {
+export type RuleOnErrorInfo = {
     /**
      * Line number (1-based).
      */
@@ -269,7 +285,7 @@ type RuleOnErrorInfo = {
 /**
  * Fix information for RuleOnErrorInfo.
  */
-type RuleOnErrorFixInfo = {
+export type RuleOnErrorFixInfo = {
     /**
      * Line number (1-based).
      */
@@ -290,7 +306,7 @@ type RuleOnErrorFixInfo = {
 /**
  * RuleOnErrorInfo with all optional properties present.
  */
-type RuleOnErrorFixInfoNormalized = {
+export type RuleOnErrorFixInfoNormalized = {
     /**
      * Line number (1-based).
      */
@@ -311,7 +327,7 @@ type RuleOnErrorFixInfoNormalized = {
 /**
  * Rule definition.
  */
-type Rule = {
+export type Rule = {
     /**
      * Rule name(s).
      */
@@ -344,7 +360,7 @@ type Rule = {
 /**
  * Configuration options.
  */
-type Options = {
+export type Options = {
     /**
      * Configuration object.
      */
@@ -395,21 +411,21 @@ type Options = {
 /**
  * A markdown-it plugin.
  */
-type Plugin = any[];
+export type Plugin = any[];
 /**
  * Function to pretty-print lint results.
  */
-type ToStringCallback = (ruleAliases?: boolean) => string;
+export type ToStringCallback = (ruleAliases?: boolean) => string;
 /**
  * Lint results (for resultVersion 3).
  */
-type LintResults = {
+export type LintResults = {
     [x: string]: LintError[];
 };
 /**
  * Lint error.
  */
-type LintError = {
+export type LintError = {
     /**
      * Line number (1-based).
      */
@@ -446,7 +462,7 @@ type LintError = {
 /**
  * Fix information.
  */
-type FixInfo = {
+export type FixInfo = {
     /**
      * Line number (1-based).
      */
@@ -467,60 +483,34 @@ type FixInfo = {
 /**
  * Called with the result of linting a string or document.
  */
-type LintContentCallback = (error: Error | null, result?: LintError[]) => void;
+export type LintContentCallback = (error: Error | null, result?: LintError[]) => void;
 /**
  * Called with the result of the lint function.
  */
-type LintCallback = (error: Error | null, results?: LintResults) => void;
+export type LintCallback = (error: Error | null, results?: LintResults) => void;
 /**
  * Configuration object for linting rules. For the JSON schema, see
  * {@link  ../schema/markdownlint-config-schema.json}.
  */
-type Configuration = import("./configuration").Configuration;
+export type Configuration = import("./configuration.d.ts").Configuration;
 /**
  * Configuration object for linting rules strictly. For the JSON schema, see
  * {@link  ../schema/markdownlint-config-schema-strict.json}.
  */
-type ConfigurationStrict = import("./configuration-strict").ConfigurationStrict;
+export type ConfigurationStrict = import("./configuration-strict.d.ts").ConfigurationStrict;
 /**
  * Rule configuration.
  */
-type RuleConfiguration = boolean | any;
+export type RuleConfiguration = boolean | any;
 /**
  * Parses a configuration string and returns a configuration object.
  */
-type ConfigurationParser = (text: string) => Configuration;
+export type ConfigurationParser = (text: string) => Configuration;
 /**
  * Called with the result of the readConfig function.
  */
-type ReadConfigCallback = (err: Error | null, config?: Configuration) => void;
+export type ReadConfigCallback = (err: Error | null, config?: Configuration) => void;
 /**
  * Called with the result of the resolveConfigExtends function.
  */
-type ResolveConfigExtendsCallback = (err: Error | null, path?: string) => void;
-/**
- * Lint specified Markdown files.
- *
- * @param {Options} options Configuration options.
- * @returns {Promise<LintResults>} Results object.
- */
-declare function markdownlintPromise(options: Options): Promise<LintResults>;
-/**
- * Extend specified configuration object.
- *
- * @param {Configuration} config Configuration object.
- * @param {string} file Configuration file name.
- * @param {ConfigurationParser[]} [parsers] Parsing function(s).
- * @param {Object} [fs] File system implementation.
- * @returns {Promise<Configuration>} Configuration object.
- */
-declare function extendConfigPromise(config: Configuration, file: string, parsers?: ConfigurationParser[], fs?: any): Promise<Configuration>;
-/**
- * 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.
- */
-declare function readConfigPromise(file: string, parsers?: ConfigurationParser[], fs?: any): Promise<Configuration>;
+export type ResolveConfigExtendsCallback = (err: Error | null, path?: string) => void;