Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Dkendal/nvim-treeclimber
Neovim structured editing plugin
https://github.com/Dkendal/nvim-treeclimber
lua neovim neovim-lua-plugin neovim-plugin nvim-treesitter treesitter
Last synced: 11 days ago
JSON representation
Neovim structured editing plugin
- Host: GitHub
- URL: https://github.com/Dkendal/nvim-treeclimber
- Owner: Dkendal
- License: apache-2.0
- Created: 2021-08-11T03:16:27.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-12T21:37:55.000Z (15 days ago)
- Last Synced: 2024-06-13T03:29:50.139Z (15 days ago)
- Topics: lua, neovim, neovim-lua-plugin, neovim-plugin, nvim-treesitter, treesitter
- Language: Lua
- Homepage:
- Size: 135 KB
- Stars: 164
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Lists
- awesome-stars - Dkendal/nvim-treeclimber - Neovim structured editing plugin (Lua)
- awesome-stars - Dkendal/nvim-treeclimber - Neovim structured editing plugin (Lua)
README
# Nvim-Treeclimber
Neovim plugin for treesitter based navigation and selection.
Takes inspiration from [ParEdit](https://calva.io/paredit/).
Requires neovim >= 0.10.
## Usage
### Navigation
| Key binding | Action | Demo |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `alt-h` | Select the previous sibling node. |  |
| `alt-j` | Shrink selection. The video also shows growing the selection first. Shrinking selects a child node from the current node, or will undo the action of a previous expand operation. |  |
| `alt-k` | Expand selection by selecting the parent of the current node or node under the cursor. |  |
| `alt-l` | Select the next sibling node. |  |
| `alt-shift-l` | Add the next sibling to the selection. |  |
| `alt-shift-h` | Add the previous sibling to the selection. |  |
| `alt-[` | Select the first sibling relative to the current node. |  |
| `alt-]` | Select the last sibling relative to the current node . |  |
| `alt-g` | Select the top level node relative to the cursor or selection. |  |
### Inspection
| Key binding | Action | Demo |
| ----------- | --------------------------------------------------------------------------- | ---------------------------------------- |
| `leader-k` | Populate the quick fix with all branches required to reach the current node | [:TCShowControlFlow](#tcshowcontrolflow) |
### Commands
#### :TCDiffThis
Diff two visual selections based on their AST difference.
Requires that [difft](https://github.com/Wilfred/difftastic) is available in your path.
To use, make your first selection and call `:TCDiffThis`, then make your second selection and call `:TCDiffThis` again.
[tc-diff-this.webm](https://user-images.githubusercontent.com/3162299/203088217-a827f8fc-ea20-4da7-95fe-884e3d82daa5.webm)
#### :TCShowControlFlow
Populate the quick fix with all branches required to reach the current node.
https://user-images.githubusercontent.com/3162299/203097777-a9a84c2d-8dec-4db8-a4c7-4c9a66ca26fe.mp4
## Installation
Use your preferred package manager, or the built-in package system (`:help packages`).
```sh
mkdir -p ~/.config/nvim/pack/dkendal/opt
cd ~/.config/nvim/pack/dkendal/opt
git clone https://github.com/dkendal/nvim-treeclimber.git
```
```lua
-- ~/.config/nvim/init.lua
vim.cmd.packadd('nvim-treeclimber')
require('nvim-treeclimber').setup()
```
If you want to change the default keybindings, call `require('nvim-treeclimber')` rather than calling setup.
See [configuration](#configuration).
## Configuration
**To use default highlight, keymaps, and commands call `require('nvim-treeclimber').setup()`.**
To manually specify the configuration options, take a look at the contents of `lua/nvim-treeclimber.lua` and import or modify the portions that you need.
For example, if you just want the built in user commands and highlights but you want your own keybindings, you can do the following:
```lua
local tc = require('nvim-treeclimber')
tc.setup_augroups()
tc.setup_user_commands()
-- Copied from setup_keymaps
vim.keymap.set("n", "k", tc.show_control_flow, {})
vim.keymap.set({ "x", "o" }, "i.", tc.select_current_node, { desc = "select current node" })
vim.keymap.set({ "x", "o" }, "a.", tc.select_expand, { desc = "select parent node" })
...
```
---
Copyright Dylan Kendal 2022.