Skip to content

Commit

Permalink
Add note about vocab: false
Browse files Browse the repository at this point in the history
  • Loading branch information
jdkato committed Aug 26, 2024
1 parent ad3e302 commit fbe33a2
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions content/en/docs/topics/vocab/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,3 +172,16 @@ vocabularies are for style *users*:

* As a user of styles, vocabularies should be able to replace the use of ignore
files completely.

## Rules targeting vocabulary entries

In cases where you want to write a rule that needs to match against an otherwise ignored token, you can add `vocab: false` to the rule definition. For example,

```ini
extends: existence
message: Did you mean '%s'?
vocab: false
tokens:
# "MonoDB" can be in a vocab
- MongoDB
```

0 comments on commit fbe33a2

Please sign in to comment.