Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-21 21:30:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Include file/string name in params object for custom rules (fixes #119).

Browse source
This commit is contained in:
David Anson 2018-05-25 17:28:56 -07:00
parent 8c87a20677
commit 1c816897c1
3 changed files with 53 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/CustomRules.md
View file

@ -38,6 +38,7 @@ A rule is implemented as an `Object` with four required properties:
- `tags` is an `Array` of `String` values that groups related rules for easier customization.
- `function` is a synchronous `Function` that implements the rule and is passed two parameters:
- `params` is an `Object` with properties that describe the content being analyzed:
- `name` is a `String` that identifies the input file/string.
- `tokens` is an `Array` of [`markdown-it` `Token` objects](https://markdown-it.github.io/markdown-it/#Token) with added `line` and `lineNumber` properties.
- `lines` is an `Array` of `String` values corresponding to the lines of the input file/string.
- `frontMatterLines` is an `Array` of `String` values corresponding to any front matter (not present in `lines`).
@ -73,6 +74,7 @@ Would create a `params` object like:
```json
{
"name": "doc/example.md",
"tokens": [
{
"type": "heading_open",