diff options
author | Gokul Soumya | 2021-07-03 01:07:49 +0000 |
---|---|---|
committer | GitHub | 2021-07-03 01:07:49 +0000 |
commit | c68fe1f2a3a40c37969c1f5d18e3134320a0c773 (patch) | |
tree | 4c5c2ff317d90f2ba520135ad0d2726d9a6cb9b2 /book/src/usage.md | |
parent | c5b2973739901f8cd4bc26f3cfc8232249eb7968 (diff) |
Add object selection (textobjects) (#385)
* Add textobjects for word
* Add textobjects for surround characters
* Apply clippy lints
* Remove ThisWordPrevBound in favor of PrevWordEnd
It's the same as PrevWordEnd except for taking the current char
into account, so use a "flag" to capture that usecase
* Add tests for PrevWordEnd movement
* Remove ThisWord* movements
They did not preserve anchor positions and were only used
for textobject boundary search anyway so replace them with
simple position finding functions
* Rewrite tests of word textobject
* Add tests for surround textobject
* Add textobject docs
* Refactor textobject word position functions
* Apply clippy lints on textobject
* Fix overflow error with textobjects
Diffstat (limited to 'book/src/usage.md')
-rw-r--r-- | book/src/usage.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/book/src/usage.md b/book/src/usage.md index e6bd60e2..0458071a 100644 --- a/book/src/usage.md +++ b/book/src/usage.md @@ -24,3 +24,19 @@ It can also act on multiple seletions (yay!). For example, to change every occur - `mr([` to replace the parens with square brackets Multiple characters are currently not supported, but planned. + +## Textobjects + +Currently supported: `word`, `surround`. + +![textobject-demo](https://user-images.githubusercontent.com/23398472/124231131-81a4bb00-db2d-11eb-9d10-8e577ca7b177.gif) + +- `ma` - Select around the object (`va` in vim, `<alt-a>` in kakoune) +- `mi` - Select inside the object (`vi` in vim, `<alt-i>` in kakoune) + +| Key after `mi` or `ma` | Textobject selected | +| --- | --- | +| `w` | Word | +| `(`, `[`, `'`, etc | Specified surround pairs | + +Textobjects based on treesitter, like `function`, `class`, etc are planned. |