Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/David-Kunz/treesitter-unit
A Neovim plugin to deal with treesitter units
https://github.com/David-Kunz/treesitter-unit
lua neovim plugin tree-sitter treesitter
Last synced: 11 days ago
JSON representation
A Neovim plugin to deal with treesitter units
- Host: GitHub
- URL: https://github.com/David-Kunz/treesitter-unit
- Owner: David-Kunz
- License: unlicense
- Created: 2021-08-21T10:51:30.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-09-12T07:46:54.000Z (about 3 years ago)
- Last Synced: 2024-10-10T23:23:53.224Z (about 1 month ago)
- Topics: lua, neovim, plugin, tree-sitter, treesitter
- Language: Lua
- Homepage:
- Size: 42 KB
- Stars: 151
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# treesitter-unit
A tiny [Neovim](https://neovim.io/) plugin to deal with [treesitter](https://github.com/tree-sitter/tree-sitter) units.
A unit is defined as a treesitter node including all its children.
It allows you to quickly select, yank, delete or replace language-specific ranges.
For inner selections, the main node under the cursor is selected.
For outer selections, the next node is selected.
## Installation
Requirements: [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) including a parser for your language
For [vim-plug](https://github.com/junegunn/vim-plug):
```
Plug 'David-Kunz/treesitter-unit'
```
For [packer](https://github.com/wbthomason/packer.nvim):
```
use 'David-Kunz/treesitter-unit'
```
## Usage
### Select treesitter unit
You can select the current treesitter unit
```
:lua require"treesitter-unit".select(outer?)
```
This function takes an optional Boolean flag to specify if the outer scope should be selected as well, default `false`.
For operations like delete, change, ... please see section "Useful mappings".
### Automatic Highlighting
You can toggle automatic highlighting for the current treesitter unit.
```
:lua require"treesitter-unit".toggle_highlighting(higroup?)
```
As an optional parameter you can specify the highlight group, default: `"CursorLine"`.
Alternative: `enable_highlighting(higroup?)` and `disable_highlighting()`.
### Useful mappings
For init.vim:
```
xnoremap iu :lua require"treesitter-unit".select()
xnoremap au :lua require"treesitter-unit".select(true)
onoremap iu :lua require"treesitter-unit".select()
onoremap au :lua require"treesitter-unit".select(true)
```
For init.lua:
```
vim.api.nvim_set_keymap('x', 'iu', ':lua require"treesitter-unit".select()', {noremap=true})
vim.api.nvim_set_keymap('x', 'au', ':lua require"treesitter-unit".select(true)', {noremap=true})
vim.api.nvim_set_keymap('o', 'iu', ':lua require"treesitter-unit".select()', {noremap=true})
vim.api.nvim_set_keymap('o', 'au', ':lua require"treesitter-unit".select(true)', {noremap=true})
```
Examples:
- `viu` to select the inner unit
- `cau` to change the outer unit
## Similar plugins
- [nvim-treesitter-textobjects](https://github.com/nvim-treesitter/nvim-treesitter-textobjects) for more fine-granular control
- [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter#incremental-selection) for incremental selection
- [nvim-ts-hint-textobject](https://github.com/mfussenegger/nvim-ts-hint-textobject)
## Making-of video
[](https://youtu.be/dPQfsASHNkg "Let's create a Neovim plugin using Treesitter and Lua")