markdownlint 0.24.0 → 0.26.0

package/helpers/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-rule-helpers",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "description": "A collection of markdownlint helper functions for custom rules",
   "main": "helpers.js",
   "author": "David Anson (https://dlaa.me/)",
@@ -11,6 +11,9 @@
     "url": "https://github.com/DavidAnson/markdownlint.git"
   },
   "bugs": "https://github.com/DavidAnson/markdownlint/issues",
+  "engines": {
+    "node": ">=12"
+  },
   "keywords": [
     "markdownlint",
     "markdownlint-rule"

package/lib/cache.js

@@ -2,32 +2,22 @@
 
 "use strict";
 
-let flattenedLists = null;
-module.exports.flattenedLists = (value) => {
-  if (value) {
-    flattenedLists = value;
-  }
-  return flattenedLists;
-};
-
-let inlineCodeSpanRanges = null;
-module.exports.inlineCodeSpanRanges = (value) => {
-  if (value) {
-    inlineCodeSpanRanges = value;
-  }
-  return inlineCodeSpanRanges;
-};
+const map = new Map();
 
-let lineMetadata = null;
-module.exports.lineMetadata = (value) => {
-  if (value) {
-    lineMetadata = value;
+module.exports.set = (keyValuePairs) => {
+  for (const [ key, value ] of Object.entries(keyValuePairs)) {
+    map.set(key, value);
   }
-  return lineMetadata;
 };
+module.exports.clear = () => map.clear();
 
-module.exports.clear = () => {
-  flattenedLists = null;
-  inlineCodeSpanRanges = null;
-  lineMetadata = null;
-};
+module.exports.codeBlockAndSpanRanges =
+  () => map.get("codeBlockAndSpanRanges");
+module.exports.flattenedLists =
+  () => map.get("flattenedLists");
+module.exports.htmlElementRanges =
+  () => map.get("htmlElementRanges");
+module.exports.lineMetadata =
+  () => map.get("lineMetadata");
+module.exports.referenceLinkImageData =
+  () => map.get("referenceLinkImageData");

package/lib/constants.js

@@ -0,0 +1,7 @@
+// @ts-check
+
+"use strict";
+
+module.exports.deprecatedRuleNames = [ "MD002", "MD006" ];
+module.exports.homepage = "https://github.com/DavidAnson/markdownlint";
+module.exports.version = "0.26.0";

package/lib/markdownlint.d.ts

@@ -14,32 +14,38 @@ declare namespace markdownlint {
  * Configuration options.
  */
 type Options = {
-    /**
-     * Files to lint.
-     */
-    files?: string[] | string;
-    /**
-     * Strings to lint.
-     */
-    strings?: {
-        [x: string]: string;
-    };
     /**
      * Configuration object.
      */
     config?: Configuration;
+    /**
+     * Configuration parsers.
+     */
+    configParsers?: ConfigurationParser[];
     /**
      * Custom rules.
      */
     customRules?: Rule[] | Rule;
+    /**
+     * Files to lint.
+     */
+    files?: string[] | string;
     /**
      * Front matter pattern.
      */
     frontMatter?: RegExp;
+    /**
+     * File system implementation.
+     */
+    fs?: any;
     /**
      * True to catch exceptions.
      */
     handleRuleFailures?: boolean;
+    /**
+     * Additional plugins.
+     */
+    markdownItPlugins?: Plugin[];
     /**
      * True to ignore HTML directives.
      */
@@ -49,13 +55,11 @@ type Options = {
      */
     resultVersion?: number;
     /**
-     * Additional plugins.
-     */
-    markdownItPlugins?: Plugin[];
-    /**
-     * File system implementation.
+     * Strings to lint.
      */
-    fs?: any;
+    strings?: {
+        [x: string]: string;
+    };
 };
 /**
  * Called with the result of the lint function.
@@ -206,9 +210,9 @@ type RuleOnErrorInfo = {
      */
     lineNumber: number;
     /**
-     * Details about the error.
+     * Detail about the error.
      */
-    details?: string;
+    detail?: string;
     /**
      * Context for the error.
      */
@@ -263,6 +267,10 @@ type Rule = {
      * Rule tag(s).
      */
     tags: string[];
+    /**
+     * True if asynchronous.
+     */
+    asynchronous?: boolean;
     /**
      * Rule implementation.
      */
@@ -342,7 +350,7 @@ type FixInfo = {
 };
 /**
  * Configuration object for linting rules. For a detailed schema, see
- * {@link ../schema/markdownlint-config-schema.json}.
+ * {@link  ../schema/markdownlint-config-schema.json}.
  */
 type Configuration = {
     [x: string]: RuleConfiguration;