Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kiyoon/treesitter-indent-object.nvim
Context-aware indent textobject powered by Treesitter. `vai` to select current context.
https://github.com/kiyoon/treesitter-indent-object.nvim
neovim neovim-plugin neovim-plugins nvim nvim-plugin nvim-treesitter treesitter vim vim-indent vim-plugin
Last synced: 11 days ago
JSON representation
Context-aware indent textobject powered by Treesitter. `vai` to select current context.
- Host: GitHub
- URL: https://github.com/kiyoon/treesitter-indent-object.nvim
- Owner: kiyoon
- License: mit
- Created: 2022-12-11T13:15:19.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-08T12:42:10.000Z (4 months ago)
- Last Synced: 2024-10-12T15:54:22.349Z (26 days ago)
- Topics: neovim, neovim-plugin, neovim-plugins, nvim, nvim-plugin, nvim-treesitter, treesitter, vim, vim-indent, vim-plugin
- Language: Lua
- Homepage:
- Size: 24.4 KB
- Stars: 50
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Treesitter-indent-object.nvim
`vai` to select current context!
Context-aware smart indent object to select block, powered by [treesitter](https://github.com/nvim-treesitter/nvim-treesitter).
This plugin is intended to be used with [indent-blankline.nvim](https://github.com/lukas-reineke/indent-blankline.nvim),
so you see the scope before you select.
> [!NOTE]
> **This plugin is only compatible with `indent-blankline.nvim` v2** because its definition of scope has been changed on v3.
> TL;DR - v2 scope is just "same indent level" while v3 uses an actual [semantic scope][scope] specific to each language.
> My personal preference is to keep using v2 as its scope aligns well with VSCode.
> The author does seem to plan on bringing back the old scope on v3 ([lukas-reineke/indent-blankline.nvim#649][issue]).
[scope]: https://en.wikipedia.org/wiki/Scope_(computer_science)
[issue]: https://github.com/lukas-reineke/indent-blankline.nvim/issues/649
## Install
Use your favourite plugin manager to install.
#### Example with lazy.nvim
This includes lazy-loading on keymaps. If you install like this, you can ignore every instruction below.
```lua
{
"kiyoon/treesitter-indent-object.nvim",
keys = {
{
"ai",
function() require'treesitter_indent_object.textobj'.select_indent_outer() end,
mode = {"x", "o"},
desc = "Select context-aware indent (outer)",
},
{
"aI",
function() require'treesitter_indent_object.textobj'.select_indent_outer(true) end,
mode = {"x", "o"},
desc = "Select context-aware indent (outer, line-wise)",
},
{
"ii",
function() require'treesitter_indent_object.textobj'.select_indent_inner() end,
mode = {"x", "o"},
desc = "Select context-aware indent (inner, partial range)",
},
{
"iI",
function() require'treesitter_indent_object.textobj'.select_indent_inner(true, 'V') end,
mode = {"x", "o"},
desc = "Select context-aware indent (inner, entire range) in line-wise visual mode",
},
},
},
{
"lukas-reineke/indent-blankline.nvim",
tag = "v2.20.8", -- Use v2
event = "BufReadPost",
config = function()
vim.opt.list = true
require("indent_blankline").setup {
space_char_blankline = " ",
show_current_context = true,
show_current_context_start = true,
}
end,
},
```
Click to see instructions for packer and vim-plug
#### Example with Packer
[wbthomason/packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
-- init.lua
require("packer").startup(function()
use "nvim-treesitter/nvim-treesitter"
use "lukas-reineke/indent-blankline.nvim" -- optional
use "kiyoon/treesitter-indent-object.nvim"
end)
```
#### Example with Plug
[junegunn/vim-plug](https://github.com/junegunn/vim-plug)
```vim
" init.vim
call plug#begin('~/.vim/plugged')
Plug 'nvim-treesitter/nvim-treesitter'
Plug 'lukas-reineke/indent-blankline.nvim' " optional
Plug 'kiyoon/treesitter-indent-object.nvim'
call plug#end()
```
## Setup
`setup()` is not required, but here is the recommendation.
```lua
require("indent_blankline").setup {
show_current_context = true,
show_current_context_start = true,
}
-- Actually, no setup is required, but
-- if setup comes after the indent_blankline,
-- it will try to follow the pattern matching options
-- used in indent_blankline
require("treesitter_indent_object").setup()
```
Key bindings are not configured by default.
Here are some examples.
```vim
" vai to select context-aware indent
xmap ai lua require'treesitter_indent_object.textobj'.select_indent_outer()
omap ai lua require'treesitter_indent_object.textobj'.select_indent_outer()
" vaI to ensure selecting entire line (or just use Vai)
xmap aI lua require'treesitter_indent_object.textobj'.select_indent_outer(true)
omap aI lua require'treesitter_indent_object.textobj'.select_indent_outer(true)
" vii to select inner block (only if block, only else block, etc.)
xmap ii lua require'treesitter_indent_object.textobj'.select_indent_inner()
omap ii lua require'treesitter_indent_object.textobj'.select_indent_inner()
" viI to select entire inner range (including if, else, etc.) in line-wise visual mode
xmap iI lua require'treesitter_indent_object.textobj'.select_indent_inner(true, 'V')
omap iI lua require'treesitter_indent_object.textobj'.select_indent_inner(true, 'V')
```
Lua equivalent:
```lua
-- select context-aware indent
vim.keymap.set({"x", "o"}, "ai", function() require'treesitter_indent_object.textobj'.select_indent_outer() end)
-- ensure selecting entire line (or just use Vai)
vim.keymap.set({"x", "o"}, "aI", function() require'treesitter_indent_object.textobj'.select_indent_outer(true) end)
-- select inner block (only if block, only else block, etc.)
vim.keymap.set({"x", "o"}, "ii", function() require'treesitter_indent_object.textobj'.select_indent_inner() end)
-- select entire inner range (including if, else, etc.) in line-wise visual mode
vim.keymap.set({"x", "o"}, "iI", function() require'treesitter_indent_object.textobj'.select_indent_inner(true, 'V') end)
```
## Tips and Tricks
#### Include Surrounding Whitespace
There is a helper function that expands current selection to the surrounding empty lines.
Call it right after the textobject and it'll try to match the behavior of the builtin `ap` (a paragraph) keymap.
See [#4](https://github.com/kiyoon/treesitter-indent-object.nvim/pull/4) for more details about its behavior.
> [!NOTE]
> This function is designed to work with line-wise selections (`'V'`) only!
```lua
{
"aI",
function()
require'treesitter_indent_object.textobj'.select_indent_outer(true, 'V')
require'treesitter_indent_object.refiner'.include_surrounding_empty_lines()
end,
mode = { "x", "o" },
},
```