Remove tokens property from RuleParams type definition (use parsers.m…

…arkdownit.tokens instead). No change to runtime behavior.
DavidAnson · Mar 8, 2024 · c44f165 · c44f165
1 parent b44566c
commit c44f165
Show file tree

Hide file tree

Showing 4 changed files with 1 addition and 9 deletions.
diff --git a/demo/markdownlint-browser.js b/demo/markdownlint-browser.js
@@ -2965,7 +2965,6 @@ module.exports = markdownlint;
  *
  * @typedef {Object} RuleParams
  * @property {string} name File/string name.
- * @property {MarkdownItToken[]} tokens Token objects from markdown-it (deprecated, use parsers.markdownit.tokens).
  * @property {MarkdownParsers} parsers Markdown parser data.
  * @property {string[]} lines File/string lines.
  * @property {string[]} frontMatterLines Front matter lines.

diff --git a/example/typescript/type-check.ts b/example/typescript/type-check.ts
@@ -117,14 +117,12 @@ const testRule: markdownlint.Rule = {
   "function": function rule(params: markdownlint.RuleParams, onError: markdownlint.RuleOnError) {
     assert(!!params);
     assert(!!onError);
-    let tokens: markdownlint.MarkdownItToken[] = [];
     let ruleParams: markdownlint.RuleParams;
     ruleParams = {
       "name": "name",
-      "tokens": tokens,
       "parsers": {
         "markdownit": {
-          "tokens": tokens
+          "tokens": []
         }
       },
       "lines": [

diff --git a/lib/markdownlint.d.ts b/lib/markdownlint.d.ts
@@ -116,10 +116,6 @@ type RuleParams = {
      * File/string name.
      */
     name: string;
-    /**
-     * Token objects from markdown-it (deprecated, use parsers.markdownit.tokens).
-     */
-    tokens: MarkdownItToken[];
     /**
      * Markdown parser data.
      */

diff --git a/lib/markdownlint.js b/lib/markdownlint.js
@@ -1286,7 +1286,6 @@ module.exports = markdownlint;
  *
  * @typedef {Object} RuleParams
  * @property {string} name File/string name.
- * @property {MarkdownItToken[]} tokens Token objects from markdown-it (deprecated, use parsers.markdownit.tokens).
  * @property {MarkdownParsers} parsers Markdown parser data.
  * @property {string[]} lines File/string lines.
  * @property {string[]} frontMatterLines Front matter lines.