mirror of
https://github.com/nvim-treesitter/nvim-treesitter.git
synced 2026-07-01 19:17:02 -04:00
169 lines
6.3 KiB
Text
169 lines
6.3 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)
|
|
node_decremental = "grm", -- decrement to the previous node
|
|
}
|
|
},
|
|
ensure_installed = 'all' -- one of 'all', 'language', or a list of languages
|
|
}
|
|
EOF
|
|
<
|
|
|
|
==============================================================================
|
|
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.
|
|
|
|
==============================================================================
|
|
UTILS *nvim-treesitter-utils*
|
|
|
|
Nvim treesitter has some wrapper functions that you can retrieve with:
|
|
>
|
|
local ts_utils = require 'nvim-treesitter.ts_utils'
|
|
<
|
|
Methods
|
|
|
|
get_node_at_cursor(winnr) *ts_utils.get_node_at_cursor*
|
|
winnr will be 0 if nil
|
|
returns the node under the cursor
|
|
|
|
get_node_text(node, bufnr) *ts_utils.get_node_text*
|
|
return the text content of a node
|
|
|
|
is_parent(dest, source) *ts_utils.is_parent*
|
|
determines wether `dest` is a parent of `source`
|
|
return a boolean
|
|
|
|
get_named_children(node) *ts_utils.get_named_children*
|
|
return a table of named children of `node`
|
|
|
|
get_next_node(node, allow_switch_parent, allow_next_parent) *ts_utils.get_next_node*
|
|
return the next node within the same parent.
|
|
if no node is found, returns `nil`.
|
|
if `allow_switch_parent` is true, it will allow switching parent
|
|
when the node is the last node
|
|
if `allow_next_parent` is true, it will allow next parent if
|
|
the node is the last node and the next parent doesn't have children.
|
|
|
|
get_previous_node(node, allow_switch_parents, allow_prev_parent) *ts_utils.get_previous_node*
|
|
return the previous node within the same parent.
|
|
`allow_switch_parent` and `allow_prev_parent` follow the same rule
|
|
as |ts_utils.get_next_node| but if the node is the first node.
|
|
|
|
containing_scope(node) *ts_utils.containing_scope*
|
|
return the smallest scope containing the node
|
|
|
|
parent_scope(node, cursor_pos) *ts_utils.parent_scope*
|
|
return the parent scope of the current scope that contains the node.
|
|
`cursor_pos` should be `{ row = number, col = number }`
|
|
|
|
nested_scope(node, cursor_pos) *ts_utils.nested_scope*
|
|
return the first scope within current scope that contains the node.
|
|
`cursor_pos` should be `{ row = number, col = number }`
|
|
|
|
next_scope(node) *ts_utils.next_scope*
|
|
return the neighbour scope of the current node
|
|
|
|
previous_scope(node) *ts_utils.previous_scope*
|
|
return the previous neighbour scope of the current node
|
|
|
|
==============================================================================
|
|
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`.
|
|
|
|
|nvim_treesitter#foldexpr()|
|
|
*nvim_treesitter#foldexpr()*
|
|
|
|
Functions to be used to determine the fold level at a given line number.
|
|
To use it: >
|
|
set foldmethod=expr
|
|
set foldexpr=nvim_treesitter#foldexr()
|
|
<
|
|
Note: This is highly experimental, and folding can break on some types of
|
|
edits. If you encounter such breakage, hiting `zx` should fix folding.
|
|
In any case, feel free to open an issue with the reproducing steps.
|
|
|
|
vim:tw=78:ts=8:noet:ft=help:norl:
|