Skip to content

Commit d6f9075

Browse files
jenningsskipjack
authored andcommitted
docs(config): clarify the meaning of Rule.parser options (#1489)
Fixes #1484
1 parent 7b9c190 commit d6f9075

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

content/configuration/module.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,12 @@ W> `Rule.query` is deprecated in favor of `Rule.options` and `UseEntry.options`.
160160

161161
An object with parser options. All applied parser options are merged.
162162

163-
For each different parser options object a new parser is created and plugins can apply plugins depending on the parser options. Many of the default plugins apply their parser plugins only if a property in the parser options is not set or true.
163+
Parsers may inspect these options and disable or reconfigure themselves accordingly. Most of the default plugins interpret the values as follows:
164+
165+
* Setting the option to `false` disables the parser.
166+
* Setting the option to `true` or leaving it `undefined` enables the parser.
167+
168+
However, parser plugins may accept more than just a boolean. For example, the internal `NodeStuffPlugin` can accept an object instead of `true` to add additional options for a particular Rule.
164169

165170
**Examples** (parser options by the default plugins):
166171

0 commit comments

Comments
 (0)