> For the complete documentation index, see [llms.txt](https://docs.vale.sh/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vale.sh/checks/existence.md). # existence Learn about the existence extension point. | Name | Type | Description | | ------------ | -------- | ---------------------------------------------------------------------------------------------------------------- | | `affix` | `string` | Names an affix file, so a `word/FLAGS` token matches every form its flags name. See [Affix flags](#affix-flags). | | `append` | `bool` | Adds `raw` to the end of `tokens`, assuming both are defined. | | `ignorecase` | `bool` | Makes all matches case-insensitive. | | `nonword` | `bool` | Removes the default word boundaries (`\b`). | | `action` | `array` | Options for correcting matches, see the [actions](/topics/actions.md) section. | | `raw` | `array` | A list of tokens to be concatenated into a pattern. | | `tokens` | `array` | A list of tokens to be transformed into a non-capturing group. | | `exceptions` | `array` | An array of strings to be ignored. | | `vocab` | `bool` | If false, disables all active [vocabularies](/keys/vocabularies.md) for this rule (default: true). | The most general extension point is existence. As its name implies, it looks for the “existence” of particular tokens. ```yaml extends: existence message: Consider removing '%s' level: warning ignorecase: true tokens: - appears to be - arguably ``` > This is arguably the best option, and it appears to be stable. ```bash test.md:1:9:style.Hedging:Consider removing 'arguably' test.md:1:42:style.Hedging:Consider removing 'appears to be' ``` These tokens can be anything from simple phrases (as in the above example) to regular expressions—e.g., [the number of spaces between sentences](https://github.com/vale-cli/vale/blob/master/testdata/styles/demo/Spacing.yml) or [the position of punctuation after quotes](https://github.com/vale-cli/Google/blob/master/Google/Quotes.yml). ### [tokens](#tokens) The most common entry point for this extension point is the `tokens` key, which is a list of strings or regular expressions to be transformed into a word-bounded, non-capturing group: ```yaml tokens: - appears to be - arguably ``` Which, after compilation, becomes: ```regex (?i)(?m)\b(?:appears\s+to\s+be|arguably)\b ``` This is a convenience feature to avoid having to write the same boilerplate for every token in a rule. A space between words matches a line break too, so a phrase is found however the paragraph was wrapped, and the alert's message shows it on one line. A space inside a character class, after a backslash, or ahead of a quantifier such as `{2,}` keeps its meaning. ### [raw](#raw) When you want more control over the regular expression, you can use the `raw` key instead: ```yaml extends: existence message: "Incorrect use of symbols in '%s'." ignorecase: true raw: - $[d]* ?(?:dollars|usd|us dollars) ``` This allows you to write more complex patterns without having to worry about any post-processing. Each entry in `raw` is concatenated with the previous entry, allowing for improved commenting and readability of complex patterns. ### [message](#message) The `message` key is a string that will be used to generate the final message when a match is found. The (optional) `%s` placeholder will be replaced with the matched text. A rule with an [action](/topics/actions.md) may use a second `%s`, which is the fix. ## Affix flags {% hint style="info" %} Requires Vale v3.25.0 or later. {% endhint %} With `affix` set, a token written as `word/FLAGS` matches every form the Hunspell [affix flags](/guides/hunspell.md) name, instead of a hand-written pattern: ```yaml extends: existence message: Avoid '%s'. affix: en_US-web tokens: - leverage/DGS # leverage, leveraged, leverages, leveraging - jump/DGS the gun # jump the gun, jumped the gun, ... ``` In a phrase, each word with flags expands on its own, and the rest of the token is a pattern as usual. A `\b` on either side of a flagged word stays a word boundary. `en_US-web` is the affix file of Vale's built-in dictionary. Any other name is looked up as a `.aff` file in `/config/dictionaries/`, then in `$DICPATH`, as a spelling rule's [dictionaries](/checks/spelling.md) are. In a rule that sets `affix`, an unescaped `/` in a space-separated word of a token separates the word from its flags, and the word must be plain text. Write a literal slash as `\/`: `and\/or`. A token without a slash is a pattern as usual. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.vale.sh/checks/existence.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.