benbot/nvim-treesitter
1
0
Fork 0
mirror of https://github.com/nvim-treesitter/nvim-treesitter.git synced 2026-07-19 11:50:09 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add documentation for node_movement, rename: textobj -> incremental_selection

Browse source
This commit is contained in:
Stephan Seitz 2020-05-03 11:10:36 +02:00
parent d0b84dd89f
commit a33bccaaf0
2 changed files with 35 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -92,7 +92,7 @@ require'nvim-treesitter.configs'.setup {
enable = true, -- false will disable the whole extension enable = true, -- false will disable the whole extension
disable = { 'c', 'rust' }, -- list of language that will be disabled disable = { 'c', 'rust' }, -- list of language that will be disabled
}, },
textobj = { -- this enables incremental selection incremental_selection = { -- this enables incremental selection
enable = true, enable = true,
disable = { 'cpp', 'lua' }, disable = { 'cpp', 'lua' },
keymaps = { -- mappings for incremental selection (visual mappings) keymaps = { -- mappings for incremental selection (visual mappings)
@ -100,6 +100,16 @@ require'nvim-treesitter.configs'.setup {
scope_incremental = "<leader>f" -- "grc" by default scope_incremental = "<leader>f" -- "grc" by default
} }
}, },
node_movement = { -- this cursor movement in node hierachy
enable = true,
disable = { 'cpp', 'rust' },
keymaps = { -- mappings for node movement (normal mappings)
move_up = "<a-k>", -- default is to move with alt key hold
move_down = "<a-j>",
move_left = "<a-h>",
move_right = "<a-l>",
}
},
ensure_installed = 'all' -- one of 'all', 'language', or a list of languages ensure_installed = 'all' -- one of 'all', 'language', or a list of languages
} }
EOF EOF
@ -124,6 +134,7 @@ Some of these features are :
- [x] Incremental selection - [x] Incremental selection
- [ ] Syntax based code folding - [ ] Syntax based code folding
- [x] Consistent syntax highlighting (the api is not quite stable yet) - [x] Consistent syntax highlighting (the api is not quite stable yet)
- [x] Cursor movement in node hierachy
You can find the roadmap [here](https://github.com/nvim-treesitter/nvim-treesitter/projects/1). You can find the roadmap [here](https://github.com/nvim-treesitter/nvim-treesitter/projects/1).
The roadmap and all features of this plugin are open to change, and any suggestion will be highly appreciated! The roadmap and all features of this plugin are open to change, and any suggestion will be highly appreciated!

36
doc/nvim-treesitter.txt
View file

@ -30,19 +30,29 @@ By default, everything is disabled. To enable support for features, in your `ini
> >
lua <<EOF lua <<EOF
require'nvim-treesitter.configs'.setup { require'nvim-treesitter.configs'.setup {
highlight = { highlight = {
enable = true, -- false will disable the whole extension enable = true, -- false will disable the whole extension
disable = { 'c', 'rust' }, -- list of language that will be disabled disable = { 'c', 'rust' }, -- list of language that will be disabled
}, },
textobj = { -- this enables incremental selection incremental_selection = { -- this enables incremental selection
enable = true, enable = true,
disable = { 'cpp', 'lua' }, disable = { 'cpp', 'lua' },
keymaps = { -- mappings for visual selection keymaps = { -- mappings for incremental selection (visual mappings)
node_incremental = "<leader>e", -- "grn" by default, node_incremental = "<leader>e", -- "grn" by default,
scope_incremental = "<leader>f" -- "grc" by default scope_incremental = "<leader>f" -- "grc" by default
} }
}, },
ensure_installed = 'all' -- can be one of 'all', 'language' or {'language1', 'language2' ... } node_movement = { -- this cursor movement in node hierachy
enable = true,
disable = { 'cpp', 'rust' },
keymaps = { -- mappings for node movement (normal mappings)
move_up = "<a-k>", -- default is to move with alt key hold
move_down = "<a-j>",
move_left = "<a-h>",
move_right = "<a-l>",
}
},
ensure_installed = 'all' -- one of 'all', 'language', or a list of languages
} }
< <