mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-22 05:40:48 +02:00
Update CustomRules.md to refer to test snapshots instead of embedding sample tokens.
This commit is contained in:
David Anson
parent
d3819c4e75
commit
790cd1353e
1 changed files with 2 additions and 233 deletions
|
|
@ -79,6 +79,7 @@ A rule is implemented as an `Object`:
|
||||||
- `tokens` is an `Array` of [`markdown-it` `Token`s][markdown-it-token]
|
- `tokens` is an `Array` of [`markdown-it` `Token`s][markdown-it-token]
|
||||||
with added `line` and `lineNumber` properties. (This property was
|
with added `line` and `lineNumber` properties. (This property was
|
||||||
previously on the `params` object.)
|
previously on the `params` object.)
|
||||||
|
- Samples for `tokens` are available via [test snapshots][tokens].
|
||||||
- `lines` is an `Array` of `String` values corresponding to the lines of the
|
- `lines` is an `Array` of `String` values corresponding to the lines of the
|
||||||
input file/string.
|
input file/string.
|
||||||
- `frontMatterLines` is an `Array` of `String` values corresponding to any
|
- `frontMatterLines` is an `Array` of `String` values corresponding to any
|
||||||
|
|
@ -142,239 +143,6 @@ exception.
|
||||||
- [CommonMark documentation and specification][commonmark]
|
- [CommonMark documentation and specification][commonmark]
|
||||||
- [`markdown-it` Markdown parser project page][markdown-it]
|
- [`markdown-it` Markdown parser project page][markdown-it]
|
||||||
|
|
||||||
## Params
|
|
||||||
|
|
||||||
The Markdown document:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
# Title
|
|
||||||
|
|
||||||
Text *text* text.
|
|
||||||
```
|
|
||||||
|
|
||||||
Yields the `params` object:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"name": "doc/example.md",
|
|
||||||
"parsers.markdownit.tokens": [
|
|
||||||
{
|
|
||||||
"type": "heading_open",
|
|
||||||
"tag": "h1",
|
|
||||||
"attrs": null,
|
|
||||||
"map": [ 0, 1 ],
|
|
||||||
"nesting": 1,
|
|
||||||
"level": 0,
|
|
||||||
"children": null,
|
|
||||||
"content": "",
|
|
||||||
"markup": "#",
|
|
||||||
"info": "",
|
|
||||||
"meta": null,
|
|
||||||
"block": true,
|
|
||||||
"hidden": false,
|
|
||||||
"line": "# Title",
|
|
||||||
"lineNumber": 1
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "inline",
|
|
||||||
"tag": "",
|
|
||||||
"attrs": null,
|
|
||||||
"map": [ 0, 1 ],
|
|
||||||
"nesting": 0,
|
|
||||||
"level": 1,
|
|
||||||
"children": [
|
|
||||||
{
|
|
||||||
"type": "text",
|
|
||||||
"tag": "",
|
|
||||||
"attrs": null,
|
|
||||||
"map": null,
|
|
||||||
"nesting": 0,
|
|
||||||
"level": 0,
|
|
||||||
"children": null,
|
|
||||||
"content": "Title",
|
|
||||||
"markup": "",
|
|
||||||
"info": "",
|
|
||||||
"meta": null,
|
|
||||||
"block": false,
|
|
||||||
"hidden": false,
|
|
||||||
"lineNumber": 1,
|
|
||||||
"line": "# Title"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"content": "Title",
|
|
||||||
"markup": "",
|
|
||||||
"info": "",
|
|
||||||
"meta": null,
|
|
||||||
"block": true,
|
|
||||||
"hidden": false,
|
|
||||||
"line": "# Title",
|
|
||||||
"lineNumber": 1
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "heading_close",
|
|
||||||
"tag": "h1",
|
|
||||||
"attrs": null,
|
|
||||||
"map": null,
|
|
||||||
"nesting": -1,
|
|
||||||
"level": 0,
|
|
||||||
"children": null,
|
|
||||||
"content": "",
|
|
||||||
"markup": "#",
|
|
||||||
"info": "",
|
|
||||||
"meta": null,
|
|
||||||
"block": true,
|
|
||||||
"hidden": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "paragraph_open",
|
|
||||||
"tag": "p",
|
|
||||||
"attrs": null,
|
|
||||||
"map": [ 2, 3 ],
|
|
||||||
"nesting": 1,
|
|
||||||
"level": 0,
|
|
||||||
"children": null,
|
|
||||||
"content": "",
|
|
||||||
"markup": "",
|
|
||||||
"info": "",
|
|
||||||
"meta": null,
|
|
||||||
"block": true,
|
|
||||||
"hidden": false,
|
|
||||||
"line": "Text *text* text.",
|
|
||||||
"lineNumber": 3
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "inline",
|
|
||||||
"tag": "",
|
|
||||||
"attrs": null,
|
|
||||||
"map": [ 2, 3 ],
|
|
||||||
"nesting": 0,
|
|
||||||
"level": 1,
|
|
||||||
"children": [
|
|
||||||
{
|
|
||||||
"type": "text",
|
|
||||||
"tag": "",
|
|
||||||
"attrs": null,
|
|
||||||
"map": null,
|
|
||||||
"nesting": 0,
|
|
||||||
"level": 0,
|
|
||||||
"children": null,
|
|
||||||
"content": "Text ",
|
|
||||||
"markup": "",
|
|
||||||
"info": "",
|
|
||||||
"meta": null,
|
|
||||||
"block": false,
|
|
||||||
"hidden": false,
|
|
||||||
"lineNumber": 3,
|
|
||||||
"line": "Text *text* text."
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "em_open",
|
|
||||||
"tag": "em",
|
|
||||||
"attrs": null,
|
|
||||||
"map": null,
|
|
||||||
"nesting": 1,
|
|
||||||
"level": 1,
|
|
||||||
"children": null,
|
|
||||||
"content": "",
|
|
||||||
"markup": "*",
|
|
||||||
"info": "",
|
|
||||||
"meta": null,
|
|
||||||
"block": false,
|
|
||||||
"hidden": false,
|
|
||||||
"lineNumber": 3,
|
|
||||||
"line": "Text *text* text."
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "text",
|
|
||||||
"tag": "",
|
|
||||||
"attrs": null,
|
|
||||||
"map": null,
|
|
||||||
"nesting": 0,
|
|
||||||
"level": 1,
|
|
||||||
"children": null,
|
|
||||||
"content": "text",
|
|
||||||
"markup": "",
|
|
||||||
"info": "",
|
|
||||||
"meta": null,
|
|
||||||
"block": false,
|
|
||||||
"hidden": false,
|
|
||||||
"lineNumber": 3,
|
|
||||||
"line": "Text *text* text."
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "em_close",
|
|
||||||
"tag": "em",
|
|
||||||
"attrs": null,
|
|
||||||
"map": null,
|
|
||||||
"nesting": -1,
|
|
||||||
"level": 0,
|
|
||||||
"children": null,
|
|
||||||
"content": "",
|
|
||||||
"markup": "*",
|
|
||||||
"info": "",
|
|
||||||
"meta": null,
|
|
||||||
"block": false,
|
|
||||||
"hidden": false,
|
|
||||||
"lineNumber": 3,
|
|
||||||
"line": "Text *text* text."
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "text",
|
|
||||||
"tag": "",
|
|
||||||
"attrs": null,
|
|
||||||
"map": null,
|
|
||||||
"nesting": 0,
|
|
||||||
"level": 0,
|
|
||||||
"children": null,
|
|
||||||
"content": " text.",
|
|
||||||
"markup": "",
|
|
||||||
"info": "",
|
|
||||||
"meta": null,
|
|
||||||
"block": false,
|
|
||||||
"hidden": false,
|
|
||||||
"lineNumber": 3,
|
|
||||||
"line": "Text *text* text."
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"content": "Text *text* text.",
|
|
||||||
"markup": "",
|
|
||||||
"info": "",
|
|
||||||
"meta": null,
|
|
||||||
"block": true,
|
|
||||||
"hidden": false,
|
|
||||||
"line": "Text *text* text.",
|
|
||||||
"lineNumber": 3
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "paragraph_close",
|
|
||||||
"tag": "p",
|
|
||||||
"attrs": null,
|
|
||||||
"map": null,
|
|
||||||
"nesting": -1,
|
|
||||||
"level": 0,
|
|
||||||
"children": null,
|
|
||||||
"content": "",
|
|
||||||
"markup": "",
|
|
||||||
"info": "",
|
|
||||||
"meta": null,
|
|
||||||
"block": true,
|
|
||||||
"hidden": false
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"lines": [
|
|
||||||
"# Title",
|
|
||||||
"",
|
|
||||||
"Text *text* text.",
|
|
||||||
""
|
|
||||||
],
|
|
||||||
"frontMatterLines": [],
|
|
||||||
"config": {
|
|
||||||
"customValue1": "abc",
|
|
||||||
"customValue2": 123
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
[commonmark]: https://commonmark.org/
|
[commonmark]: https://commonmark.org/
|
||||||
[electron]: https://github.com/electron/lint-roller/tree/main/markdownlint-rules
|
[electron]: https://github.com/electron/lint-roller/tree/main/markdownlint-rules
|
||||||
[extended-ascii]: https://github.com/DavidAnson/markdownlint-rule-extended-ascii
|
[extended-ascii]: https://github.com/DavidAnson/markdownlint-rule-extended-ascii
|
||||||
|
|
@ -387,3 +155,4 @@ Yields the `params` object:
|
||||||
[rule-helpers]: https://www.npmjs.com/package/markdownlint-rule-helpers
|
[rule-helpers]: https://www.npmjs.com/package/markdownlint-rule-helpers
|
||||||
[options-custom-rules]: ../README.md#optionscustomrules
|
[options-custom-rules]: ../README.md#optionscustomrules
|
||||||
[test-rules]: ../test/rules
|
[test-rules]: ../test/rules
|
||||||
|
[tokens]: ../test/snapshots/markdownlint-test-custom-rules.js.md
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue