mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2026-01-07 00:18:49 +01:00
Add "configParsers" option so custom parsers can be used to handle the content of markdownlint-configure-file inline comments (fixes #528).
This commit is contained in:
parent
bbec8c5c1e
commit
00082ee8a5
6 changed files with 267 additions and 108 deletions
25
README.md
25
README.md
|
|
@ -263,8 +263,11 @@ or
|
|||
-->
|
||||
```
|
||||
|
||||
These changes apply to the entire file regardless of where the comment
|
||||
is located. Multiple such comments (if present) are applied top-to-bottom.
|
||||
These changes apply to the entire file regardless of where the comment is
|
||||
located. Multiple such comments (if present) are applied top-to-bottom. By
|
||||
default, content of `markdownlint-configure-file` is assumed to be JSON, but
|
||||
[`options.configParsers`](#optionsconfigparsers) can be used to support
|
||||
alternate formats.
|
||||
|
||||
## API
|
||||
|
||||
|
|
@ -406,6 +409,24 @@ const options = {
|
|||
};
|
||||
```
|
||||
|
||||
##### options.configParsers
|
||||
|
||||
Type: *Optional* `Array` of `Function` taking (`String`) and returning `Object`
|
||||
|
||||
Array of functions to parse the content of `markdownlint-configure-file` blocks.
|
||||
|
||||
As shown in the [Configuration](#configuration) section, inline comments can be
|
||||
used to customize the [configuration object](#optionsconfig) for a document. By
|
||||
default, the `JSON.parse` built-in is used, but custom parsers can be specified.
|
||||
Content is passed to each parser function until one returns a value (vs. throwing
|
||||
an exception). As such, strict parsers should come before flexible ones.
|
||||
|
||||
For example:
|
||||
|
||||
```js
|
||||
[ JSON.parse, require("toml").parse, require("js-yaml").load ]
|
||||
```
|
||||
|
||||
##### options.customRules
|
||||
|
||||
Type: `Array` of `Object`
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue