--filter
The --filter
option allows you to report an arbitrary subset of your .vale.ini
configuration.
A filter is an expression targeting one of the following keys defined in the rule definition: .Name
, .Level
, .Scope
, .Message
, .Description
, .Extends
, or .Link
.
You can pass filters through the CLI as a string:
vale --filter='"heading" in .Scope' test.md
Or a local file:
vale --filter='some/path/filter.expr' test.md
Examples
# Filter by `.Level` and `.Name`
.Level in ["error", "suggestion"] and .Name != "demo.Cap"
# Filter by `.Extends`
.Extends=="existence"
# Filter by `.Scope`
"heading" in .Scope