markdownlint 0.34.0 → 0.36.0

package/lib/constants.js

@@ -8,7 +8,8 @@ module.exports.fixableRuleNames = [
   "MD012", "MD014", "MD018", "MD019", "MD020", "MD021",
   "MD022", "MD023", "MD026", "MD027", "MD030", "MD031",
   "MD032", "MD034", "MD037", "MD038", "MD039", "MD044",
-  "MD047", "MD049", "MD050", "MD051", "MD053", "MD054"
+  "MD047", "MD049", "MD050", "MD051", "MD053", "MD054",
+  "MD058"
 ];
 module.exports.homepage = "https://github.com/DavidAnson/markdownlint";
-module.exports.version = "0.34.0";
+module.exports.version = "0.36.0";

package/lib/markdownit.cjs

@@ -0,0 +1,172 @@
+// @ts-check
+
+"use strict";
+
+const { newLineRe } = require("../helpers");
+
+/**
+ * @callback InlineCodeSpanCallback
+ * @param {string} code Code content.
+ * @param {number} lineIndex Line index (0-based).
+ * @param {number} columnIndex Column index (0-based).
+ * @param {number} ticks Count of backticks.
+ * @returns {void}
+ */
+
+/**
+ * Calls the provided function for each inline code span's content.
+ *
+ * @param {string} input Markdown content.
+ * @param {InlineCodeSpanCallback} handler Callback function taking (code,
+ * lineIndex, columnIndex, ticks).
+ * @returns {void}
+ */
+function forEachInlineCodeSpan(input, handler) {
+  const backtickRe = /`+/g;
+  let match = null;
+  const backticksLengthAndIndex = [];
+  while ((match = backtickRe.exec(input)) !== null) {
+    backticksLengthAndIndex.push([ match[0].length, match.index ]);
+  }
+  const newLinesIndex = [];
+  while ((match = newLineRe.exec(input)) !== null) {
+    newLinesIndex.push(match.index);
+  }
+  let lineIndex = 0;
+  let lineStartIndex = 0;
+  let k = 0;
+  for (let i = 0; i < backticksLengthAndIndex.length - 1; i++) {
+    const [ startLength, startIndex ] = backticksLengthAndIndex[i];
+    if ((startIndex === 0) || (input[startIndex - 1] !== "\\")) {
+      for (let j = i + 1; j < backticksLengthAndIndex.length; j++) {
+        const [ endLength, endIndex ] = backticksLengthAndIndex[j];
+        if (startLength === endLength) {
+          for (; k < newLinesIndex.length; k++) {
+            const newLineIndex = newLinesIndex[k];
+            if (startIndex < newLineIndex) {
+              break;
+            }
+            lineIndex++;
+            lineStartIndex = newLineIndex + 1;
+          }
+          const columnIndex = startIndex - lineStartIndex + startLength;
+          handler(
+            input.slice(startIndex + startLength, endIndex),
+            lineIndex,
+            columnIndex,
+            startLength
+          );
+          i = j;
+          break;
+        }
+      }
+    }
+  }
+}
+
+/**
+ * Freeze all freeze-able members of a token and its children.
+ *
+ * @param {import("./markdownlint").MarkdownItToken} token A markdown-it token.
+ * @returns {void}
+ */
+function freezeToken(token) {
+  if (token.attrs) {
+    for (const attr of token.attrs) {
+      Object.freeze(attr);
+    }
+    Object.freeze(token.attrs);
+  }
+  if (token.children) {
+    for (const child of token.children) {
+      freezeToken(child);
+    }
+    Object.freeze(token.children);
+  }
+  if (token.map) {
+    Object.freeze(token.map);
+  }
+  Object.freeze(token);
+}
+
+/**
+ * Annotate tokens with line/lineNumber and freeze them.
+ *
+ * @param {Object[]} tokens Array of markdown-it tokens.
+ * @param {string[]} lines Lines of Markdown content.
+ * @returns {void}
+ */
+function annotateAndFreezeTokens(tokens, lines) {
+  let trMap = null;
+  // eslint-disable-next-line jsdoc/valid-types
+  /** @type import("./markdownlint").MarkdownItToken[] */
+  // @ts-ignore
+  const markdownItTokens = tokens;
+  for (const token of markdownItTokens) {
+    // Provide missing maps for table content
+    if (token.type === "tr_open") {
+      trMap = token.map;
+    } else if (token.type === "tr_close") {
+      trMap = null;
+    }
+    if (!token.map && trMap) {
+      token.map = [ ...trMap ];
+    }
+    // Update token metadata
+    if (token.map) {
+      token.line = lines[token.map[0]];
+      token.lineNumber = token.map[0] + 1;
+      // Trim bottom of token to exclude whitespace lines
+      while (token.map[1] && !((lines[token.map[1] - 1] || "").trim())) {
+        token.map[1]--;
+      }
+    }
+    // Annotate children with lineNumber
+    if (token.children) {
+      const codeSpanExtraLines = [];
+      if (token.children.some((child) => child.type === "code_inline")) {
+        forEachInlineCodeSpan(token.content, (code) => {
+          codeSpanExtraLines.push(code.split(newLineRe).length - 1);
+        });
+      }
+      let lineNumber = token.lineNumber;
+      for (const child of token.children) {
+        child.lineNumber = lineNumber;
+        child.line = lines[lineNumber - 1];
+        if ((child.type === "softbreak") || (child.type === "hardbreak")) {
+          lineNumber++;
+        } else if (child.type === "code_inline") {
+          lineNumber += codeSpanExtraLines.shift();
+        }
+      }
+    }
+    freezeToken(token);
+  }
+  Object.freeze(tokens);
+}
+
+/**
+ * Gets an array of markdown-it tokens for the input.
+ *
+ * @param {import("./markdownlint").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.
+ */
+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, {});
+  annotateAndFreezeTokens(tokens, lines);
+  // @ts-ignore
+  return tokens;
+};
+
+module.exports = {
+  forEachInlineCodeSpan,
+  getMarkdownItTokens
+};

package/lib/markdownlint.d.ts

@@ -8,63 +8,8 @@ export = markdownlint;
  */
 declare function markdownlint(options: Options | null, callback: LintCallback): void;
 declare namespace markdownlint {
-    export { markdownlintSync as sync, readConfig, readConfigSync, getVersion, promises, RuleFunction, RuleParams, MarkdownParsers, ParserMarkdownIt, ParserMicromark, MarkdownItToken, MicromarkTokenType, MicromarkToken, RuleOnError, RuleOnErrorInfo, RuleOnErrorFixInfo, Rule, Options, Plugin, ToStringCallback, LintResults, LintError, FixInfo, LintContentCallback, LintCallback, Configuration, RuleConfiguration, ConfigurationParser, ReadConfigCallback, ResolveConfigExtendsCallback };
+    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 };
 }
-/**
- * Configuration options.
- */
-type Options = {
-    /**
-     * Configuration object.
-     */
-    config?: Configuration;
-    /**
-     * Configuration parsers.
-     */
-    configParsers?: ConfigurationParser[];
-    /**
-     * Custom rules.
-     */
-    customRules?: Rule[] | Rule;
-    /**
-     * Files to lint.
-     */
-    files?: string[] | string;
-    /**
-     * Front matter pattern.
-     */
-    frontMatter?: RegExp | null;
-    /**
-     * File system implementation.
-     */
-    fs?: any;
-    /**
-     * True to catch exceptions.
-     */
-    handleRuleFailures?: boolean;
-    /**
-     * Additional plugins.
-     */
-    markdownItPlugins?: Plugin[];
-    /**
-     * True to ignore HTML directives.
-     */
-    noInlineConfig?: boolean;
-    /**
-     * Results object version.
-     */
-    resultVersion?: number;
-    /**
-     * Strings to lint.
-     */
-    strings?: {
-        [x: string]: string;
-    };
-};
-/**
- * Called with the result of the lint function.
- */
-type LintCallback = (error: Error | null, results?: LintResults) => void;
 /**
  * Lint specified Markdown files synchronously.
  *
@@ -104,6 +49,23 @@ declare namespace promises {
     export { extendConfigPromise as extendConfig };
     export { readConfigPromise as readConfig };
 }
+/**
+ * Applies the specified fix to a Markdown content line.
+ *
+ * @param {string} line Line of Markdown content.
+ * @param {RuleOnErrorFixInfo} fixInfo RuleOnErrorFixInfo instance.
+ * @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;
+/**
+ * Applies as many of the specified fixes as possible to Markdown content.
+ *
+ * @param {string} input Lines of Markdown content.
+ * @param {RuleOnErrorInfo[]} errors RuleOnErrorInfo instances.
+ * @returns {string} Fixed content.
+ */
+declare function applyFixes(input: string, errors: RuleOnErrorInfo[]): string;
 /**
  * Function to implement rule logic.
  */
@@ -132,6 +94,10 @@ type RuleParams = {
      * Rule configuration.
      */
     config: RuleConfiguration;
+    /**
+     * Version of the markdownlint library.
+     */
+    version: string;
 };
 /**
  * Markdown parser data.
@@ -321,6 +287,27 @@ type RuleOnErrorFixInfo = {
      */
     insertText?: string;
 };
+/**
+ * RuleOnErrorInfo with all optional properties present.
+ */
+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.
  */
@@ -354,6 +341,57 @@ type Rule = {
      */
     function: RuleFunction;
 };
+/**
+ * Configuration options.
+ */
+type Options = {
+    /**
+     * Configuration object.
+     */
+    config?: Configuration;
+    /**
+     * Configuration parsers.
+     */
+    configParsers?: ConfigurationParser[];
+    /**
+     * Custom rules.
+     */
+    customRules?: Rule[] | Rule;
+    /**
+     * Files to lint.
+     */
+    files?: string[] | string;
+    /**
+     * Front matter pattern.
+     */
+    frontMatter?: RegExp | null;
+    /**
+     * File system implementation.
+     */
+    fs?: any;
+    /**
+     * True to catch exceptions.
+     */
+    handleRuleFailures?: boolean;
+    /**
+     * Additional plugins.
+     */
+    markdownItPlugins?: Plugin[];
+    /**
+     * True to ignore HTML directives.
+     */
+    noInlineConfig?: boolean;
+    /**
+     * Results object version.
+     */
+    resultVersion?: number;
+    /**
+     * Strings to lint.
+     */
+    strings?: {
+        [x: string]: string;
+    };
+};
 /**
  * A markdown-it plugin.
  */
@@ -430,11 +468,20 @@ type FixInfo = {
  * Called with the result of linting a string or document.
  */
 type LintContentCallback = (error: Error | null, result?: LintError[]) => void;
+/**
+ * Called with the result of the lint function.
+ */
+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;
+/**
+ * Configuration object for linting rules strictly. For the JSON schema, see
+ * {@link  ../schema/markdownlint-config-schema-strict.json}.
+ */
+type ConfigurationStrict = import("./configuration-strict").ConfigurationStrict;
 /**
  * Rule configuration.
  */