Remove tokens property from RuleParams type definition (use parsers.markdownit.tokens instead). No change to runtime behavior.

This commit is contained in:
David Anson 2024-03-07 21:14:08 -08:00
parent b44566c6bc
commit c44f165fe1
4 changed files with 1 additions and 9 deletions

View file

@ -2965,7 +2965,6 @@ module.exports = markdownlint;
* *
* @typedef {Object} RuleParams * @typedef {Object} RuleParams
* @property {string} name File/string name. * @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 {MarkdownParsers} parsers Markdown parser data.
* @property {string[]} lines File/string lines. * @property {string[]} lines File/string lines.
* @property {string[]} frontMatterLines Front matter lines. * @property {string[]} frontMatterLines Front matter lines.

View file

@ -117,14 +117,12 @@ const testRule: markdownlint.Rule = {
"function": function rule(params: markdownlint.RuleParams, onError: markdownlint.RuleOnError) { "function": function rule(params: markdownlint.RuleParams, onError: markdownlint.RuleOnError) {
assert(!!params); assert(!!params);
assert(!!onError); assert(!!onError);
let tokens: markdownlint.MarkdownItToken[] = [];
let ruleParams: markdownlint.RuleParams; let ruleParams: markdownlint.RuleParams;
ruleParams = { ruleParams = {
"name": "name", "name": "name",
"tokens": tokens,
"parsers": { "parsers": {
"markdownit": { "markdownit": {
"tokens": tokens "tokens": []
} }
}, },
"lines": [ "lines": [

View file

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

View file

@ -1286,7 +1286,6 @@ module.exports = markdownlint;
* *
* @typedef {Object} RuleParams * @typedef {Object} RuleParams
* @property {string} name File/string name. * @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 {MarkdownParsers} parsers Markdown parser data.
* @property {string[]} lines File/string lines. * @property {string[]} lines File/string lines.
* @property {string[]} frontMatterLines Front matter lines. * @property {string[]} frontMatterLines Front matter lines.