Unnamed repository; edit this file 'description' to name the repository.
Diffstat (limited to 'book/src/guides/textobject.md')
| -rw-r--r-- | book/src/guides/textobject.md | 40 |
1 files changed, 9 insertions, 31 deletions
diff --git a/book/src/guides/textobject.md b/book/src/guides/textobject.md index 093129d4..50b3b574 100644 --- a/book/src/guides/textobject.md +++ b/book/src/guides/textobject.md @@ -1,14 +1,14 @@ -## Adding textobject queries +# Adding Textobject Queries -Helix supports textobjects that are language specific, such as functions, classes, etc. -These textobjects require an accompanying tree-sitter grammar and a `textobjects.scm` query file +Textobjects that are language specific ([like functions, classes, etc][textobjects]) +require an accompanying tree-sitter grammar and a `textobjects.scm` query file to work properly. Tree-sitter allows us to query the source code syntax tree and capture specific parts of it. The queries are written in a lisp dialect. More information on how to write queries can be found in the [official tree-sitter -documentation][tree-sitter-queries]. +documentation](tree-sitter-queries). Query files should be placed in `runtime/queries/{language}/textobjects.scm` -when contributing to Helix. Note that to test the query files locally you should put +when contributing. Note that to test the query files locally you should put them under your local runtime directory (`~/.config/helix/runtime` on Linux for example). @@ -20,33 +20,11 @@ The following [captures][tree-sitter-captures] are recognized: | `function.around` | | `class.inside` | | `class.around` | -| `test.inside` | -| `test.around` | | `parameter.inside` | -| `parameter.around` | -| `comment.inside` | -| `comment.around` | -| `entry.inside` | -| `entry.around` | -| `xml-element.inside` | -| `xml-element.around` | [Example query files][textobject-examples] can be found in the helix GitHub repository. -## Queries for textobject based navigation - -Tree-sitter based navigation in Helix is done using captures in the -following order: - -- `object.movement` -- `object.around` -- `object.inside` - -For example if a `function.around` capture has been already defined for a language -in its `textobjects.scm` file, function navigation should also work automatically. -`function.movement` should be defined only if the node captured by `function.around` -doesn't make sense in a navigation context. - -[tree-sitter-queries]: https://tree-sitter.github.io/tree-sitter/using-parsers/queries/1-syntax.html -[tree-sitter-captures]: https://tree-sitter.github.io/tree-sitter/using-parsers/queries/2-operators.html#capturing-nodes -[textobject-examples]: https://github.com/search?q=repo%3Ahelix-editor%2Fhelix+path%3A%2A%2A/textobjects.scm&type=Code&ref=advsearch&l=&l= +[textobjects]: ../usage.md#textobjects +[tree-sitter-queries]: https://tree-sitter.github.io/tree-sitter/using-parsers#query-syntax +[tree-sitter-captures]: https://tree-sitter.github.io/tree-sitter/using-parsers#capturing-nodes +[textobject-examples]: https://github.com/search?q=repo%3Ahelix-editor%2Fhelix+filename%3Atextobjects.scm&type=Code&ref=advsearch&l=&l= |