diff options
| author | Thomas Vigouroux <thomas.vigouroux@protonmail.com> | 2022-09-11 08:23:54 +0200 |
|---|---|---|
| committer | Thomas Vigouroux <thomas.vigouroux@protonmail.com> | 2022-09-12 17:14:27 +0200 |
| commit | a3272cf452c7df000974d39a5f4b43b4c20990a7 (patch) | |
| tree | 0986aef6b58f498ce40eb1e4cfb20800221d2e81 | |
| parent | 1939518ebab72878f2a8ca0cb85c09f7e70d1093 (diff) | |
| download | rneovim-a3272cf452c7df000974d39a5f4b43b4c20990a7.tar.gz rneovim-a3272cf452c7df000974d39a5f4b43b4c20990a7.tar.bz2 rneovim-a3272cf452c7df000974d39a5f4b43b4c20990a7.zip | |
docs(treesitter): suggest using `extends` to extend queries
| -rw-r--r-- | runtime/doc/treesitter.txt | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt index 0a48b435b6..491aea793c 100644 --- a/runtime/doc/treesitter.txt +++ b/runtime/doc/treesitter.txt @@ -190,7 +190,7 @@ supported by Neovim. By default, the first query on `runtimepath` is used (which usually implies that user config takes precedence over plugins, which take precedence over queries bundled with Neovim). If a query should extend other queries instead -of replacing them, use the `; extends` modeline below. +of replacing them, use |ts-modeline-extends|. A `query` consists of one or more patterns. A `pattern` is defined over node types in the syntax tree. A `match` corresponds to specific elements of the @@ -199,16 +199,20 @@ and predicates. A `capture` allows you to associate names with a specific node in a pattern. A `predicate` adds arbitrary metadata and conditional data to a match. + *ts-query-modeline* Neovim supports to customize the behavior of the queries using a set of "modelines", that is comments in the queries starting with `;`. Here are the currently supported modeline alternatives: - `inherits: {lang}...` + `inherits: {lang}...` *ts-modeline-inherits* Specifies that this query should inherit the queries from {lang}. This will recursively descend in the queries of {lang} unless wrapped in parentheses: `({lang})`. + Note: this is meant to be used to include queries from another + language. If you want your query to extend the queries of the same + language, use `extends`. - `extends` + `extends` *ts-modeline-extends* Specifies that this query should be used as an extension for the query, i.e. that it should be merged with the others. Note: the order of the extensions, and the query that will be used as |