Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gsuuon/tshjkl.nvim
Tree-sitter hjkl movement for neovim
https://github.com/gsuuon/tshjkl.nvim
neovim nvim nvim-plugin tree-sitter
Last synced: about 1 month ago
JSON representation
Tree-sitter hjkl movement for neovim
- Host: GitHub
- URL: https://github.com/gsuuon/tshjkl.nvim
- Owner: gsuuon
- Created: 2023-06-27T17:44:11.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-07T00:39:14.000Z (4 months ago)
- Last Synced: 2024-02-07T18:43:02.493Z (4 months ago)
- Topics: neovim, nvim, nvim-plugin, tree-sitter
- Language: Lua
- Homepage:
- Size: 38.1 KB
- Stars: 90
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Lists
- awesome-neovim - gsuuon/tshjkl.nvim - Toggle to navigate and select tree-sitter nodes with hjkl. (Motion / GitHub)
- awesome-stars - gsuuon/tshjkl.nvim - Tree-sitter hjkl movement for neovim (Lua)
- awesome-neovim - gsuuon/tshjkl.nvim - Toggle to navigate and select tree-sitter nodes with hjkl. (Motion / GitHub)
- awesome-neovim - gsuuon/tshjkl.nvim - Toggle to navigate and select tree-sitter nodes with hjkl. (Motion / GitHub)
README
# tshjkl.nvim 🌳
Tree-sitter `hjkl` mode
## Usage
Toggle into `tshjkl` mode, then use `hjkl` to change scope or select a sibling node. Toggle is mapped to `` (`Alt-v`) and nodes are visually selected by default. Toggle, movement keys, extmark highlights and select mode can be configured - check [init.lua](lua/tshjkl/init.lua) to see configuration and defaults.
### Demo
https://github.com/gsuuon/tshjkl.nvim/assets/6422188/58944f74-efab-4db8-bf51-d659f35c5759
### Example
Unwrapping a function
- toggle with cursor over the inner body
- change scope if you need to
- `d`
- toggle the node to replace
- `p`
https://github.com/gsuuon/tshjkl.nvim/assets/6422188/008843a0-a6be-43c7-999f-d68ce1278307
## Install
lazy.nvim:
```lua
{
'gsuuon/tshjkl.nvim',
config = true
}
```
packer.nvim:
```lua
use {
'gsuuon/tshjkl.nvim',
config = function()
require('tshjkl').setup()
end
}
```
### Configure
You can override the [default config](lua/tshjkl/init.lua) with lazy `opts`:
```lua
{
'gsuuon/tshjkl.nvim',
opts = {
-- false to highlight only. Note that enabling this will hide the highlighting of child nodes
select_current_node = true,
keymaps = {
toggle = 'ct',
},
marks = {
parent = {
virt_text = { {'h', 'ModeMsg'} },
virt_text_pos = 'overlay'
},
child = {
virt_text = { {'l', 'ModeMsg'} },
virt_text_pos = 'overlay'
},
prev = {
virt_text = { {'k', 'ModeMsg'} },
virt_text_pos = 'overlay'
},
next = {
virt_text = { {'j', 'ModeMsg'} },
virt_text_pos = 'overlay'
}
},
binds = function(bind, tshjkl)
bind('', function()
tshjkl.exit(true)
end)
bind('q', function()
tshjkl.exit(true)
end)
bind('t', function()
print(tshjkl.current_node():type())
end)
end,
}
}
```
Or packer in `require('tshjkl').setup({})`:
```lua
use {
'gsuuon/tshjkl.nvim',
config = function()
require('tshjkl').setup({
keymaps = {
toggle = 'N',
}
})
end
}
```
The default options will visual select the current node - since the visual highlight will render over other highlights, you won't see the child extmarks. If you prefer to see those, set `select_current_node = false` and use the `v` keybind in ts-mode to manually select the current node instead.
## Keymaps
Check [binds](https://github.com/gsuuon/tshjkl.nvim/blob/9c608e4a70c69a4ab0e01f22a2f507106491c4af/lua/tshjkl/init.lua#L326) for more
`v` — visual select the current node (if `config.select_current_node` is false)
`b` — visual select backwards
`h` — parent
`j` — next sibling
`k` — previous sibling
`l` — child
`H` — top-most parent
`J` — last sibling
`K` — first sibling
`L` — inner-most child
### Binds
You can bind additional keys for 'tshjkl' mode with the `binds` option. This takes a function of which takes `bind` and `tshjkl` - bind lets you bind additional keys, and tshjkl exposes `tshjkl.current_node()`, `tshjkl.set_node()` and `tshjkl.exit()`. Pass `true` to `tshjkl.exit` to drop to normal mode (if `select_current_node` is true).
You can also add binds per buffer by setting `vim.b.tshjkl_binds`, for example in `ftplugin/lua.lua`:
```lua
vim.b.tshjkl_binds = function(bind, tshjkl)
bind('f', function()
local node = tshjkl.current_node()
while node do
local type = node:type()
if type:match('function_de') then -- declaration or definition
tshjkl.set_node(node)
return
end
node = node:parent()
end
end)
end
```
## Motivation
This plugin makes it easier to work with tree-sitter nodes - I've found it often surprising which node is under the cursor so I want to make navigating nodes as easy as basic navigation in Neovim. Visual select by default lets you do normal operations without too much extra thought - this just helps you easily select the node you're interested in.