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

Add options.handleRuleFailures for custom rule exceptions.

Browse source
This commit is contained in:
David Anson 2019-05-18 12:32:52 -07:00
parent 0e5c44617f
commit 0f72bf054b
4 changed files with 232 additions and 67 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -360,6 +360,21 @@ title: Title
Note: Matches must occur at the start of the file.
##### options.handleRuleFailures
Type: `Boolean`
Catches exceptions thrown during rule processing and reports the problem as a
rule violation.
By default, exceptions thrown by rules (or the library itself) are unhandled
and bubble up the stack to the caller in the conventional manner. By setting
`handleRuleFailures` to `true`, exceptions thrown by failing rules will be
handled by the library and the exception message logged as a rule violation.
This setting can be useful in the presence of (custom) rules that encounter
unexpected syntax and fail. By enabling this option, the linting process is
allowed to continue and report any violations that were found.
##### options.noInlineConfig
Type: `Boolean`