mirror of
https://github.com/nvim-treesitter/nvim-treesitter.git
synced 2026-07-01 19:17:02 -04:00
45dcebb15f
features:
- node_movement is moving between scopes.
- add selection initialization from normal mode
- add a decremental selection
improvements:
- attach to buffer to run tree parsing on change
- run state update on CursorMoved
- the buffer state is:
```
{
cursor_pos = { row=row, col=col },
current_node = node_under_cursor,
selection = {
range = nil, -- activates when starting a selection
nodes = {} -- filling up when starting an incremental selection
},
parser = parser, -- parser for current buffer
}
```
- refacto all the modules reliant on parsing the tree, update the current nodes, get the current nodes...
fixes:
- fix has_parser to look for .so libraries
- fix should select the whole file when selection root in selection
114 lines
4 KiB
Text
114 lines
4 KiB
Text
*nvim-treesitter*
|
|
|
|
Minimum version of neovim: nightly
|
|
|
|
Authors: Yazdani Kiyan <yazdani.kiyan@protonmail.com>, Vigouroux Thomas <tomvig38@gmail.com>
|
|
|
|
==============================================================================
|
|
INTRODUCTION *nvim-treesitter-intro*
|
|
|
|
nvim-treesitter wraps the neovim treesitter api to provide functionnalities such
|
|
as highlighting and incremental selection, and a command to easily install parsers.
|
|
|
|
==============================================================================
|
|
QUICK START *nvim-treesitter-quickstart*
|
|
|
|
Install the parser for your language
|
|
|
|
>
|
|
:TSInstall {language}
|
|
<
|
|
|
|
To get a list of supported languages
|
|
|
|
>
|
|
:TSInstallInfo
|
|
<
|
|
|
|
By default, everything is disabled. To enable support for features, in your `init.vim`:
|
|
|
|
>
|
|
lua <<EOF
|
|
require'nvim-treesitter.configs'.setup {
|
|
highlight = {
|
|
enable = true, -- false will disable the whole extension
|
|
disable = { 'c', 'rust' }, -- list of language that will be disabled
|
|
},
|
|
incremental_selection = {
|
|
enable = true,
|
|
disable = { 'cpp', 'lua' },
|
|
keymaps = { -- mappings for incremental selection (visual mappings)
|
|
init_selection = 'gnn', -- maps in normal mode to init the node/scope selection
|
|
node_incremental = "grn", -- increment to the upper named parent
|
|
scope_incremental = "grc", -- increment to the upper scope (as defined in locals.scm)
|
|
scope_decremental = "grm", -- decrement to the previous scope
|
|
}
|
|
},
|
|
node_movement = { -- this cursor movement in node hierachy
|
|
enable = true,
|
|
disable = { 'cpp', 'rust' },
|
|
keymaps = { -- mappings for scope movement
|
|
parent_scope = "<a-k>", -- default is to move with alt key hold
|
|
child_scope = "<a-j>",
|
|
next_scope = "<a-h>",
|
|
previous_scope = "<a-l>",
|
|
}
|
|
},
|
|
ensure_installed = 'all' -- one of 'all', 'language', or a list of languages
|
|
}
|
|
<
|
|
|
|
==============================================================================
|
|
COMMANDS *nvim-treesitter-commands*
|
|
|
|
|:TSInstall| {language} *:TSInstall*
|
|
|
|
Download, compile and install a parser for {language}
|
|
|
|
|:TSInstallInfo| *:TSInstallInfo*
|
|
|
|
List informations about currently installed parsers
|
|
|
|
|:TSBufEnable| {module} *:TSBufEnable*
|
|
|
|
Enable {module} on the current buffer.
|
|
A list of modules can be found at |:TSModuleInfo|
|
|
|
|
|:TSBufDisable| {module} *:TSBufDisable*
|
|
|
|
Disable {module} on the current buffer
|
|
A list of modules can be found at |:TSModuleInfo|
|
|
|
|
|:TSBufEnableAll| {module} [{language}] *:TSBufEnableAll*
|
|
|
|
Enable {module} for the session
|
|
if {language} is specified, enable module for the session only for this
|
|
particular language.
|
|
A list of modules can be found at |:TSModuleInfo|
|
|
A list of languages can be found at |:TSInstallInfo|
|
|
|
|
|:TSBufDisableAll| {module} [{language}] *:TSBufDisableAll*
|
|
|
|
Disable {module} for the session
|
|
if {language} is specified, disable module for the session only for this
|
|
particular language.
|
|
A list of modules can be found at |:TSModuleInfo|
|
|
A list of languages can be found at |:TSInstallInfo|
|
|
|
|
|:TSModuleInfo| [{module}] *:TSModuleInfo*
|
|
|
|
List modules state for the current session.
|
|
|
|
==============================================================================
|
|
FUNCTIONS~
|
|
*nvim-treesitter-functions*
|
|
|
|
|nvim_treesitter#statusline(size)|
|
|
*nvim_treesitter#statusline()*
|
|
|
|
Returns a string describing the current position in the syntax tree. This
|
|
could be used as a statusline indicator.
|
|
Note: The `size` argument is optionnal. When specified, the string will not be
|
|
longer than `size`.
|
|
|
|
vim:tw=78:ts=8:noet:ft=help:norl:
|