diff options
| author | kiyan42 <yazdani.kiyan@protonmail.com> | 2020-06-19 13:51:09 +0200 |
|---|---|---|
| committer | kiyan42 <yazdani.kiyan@protonmail.com> | 2020-06-19 14:03:01 +0200 |
| commit | cabe61ac19a2d0377a46ef48499eb292e12ae5fb (patch) | |
| tree | 9b1ae62bb6bd12550e09d6edb0d444c8a509aeb0 /doc | |
| parent | refacto: remove buf_state (diff) | |
| download | nvim-treesitter-cabe61ac19a2d0377a46ef48499eb292e12ae5fb.tar nvim-treesitter-cabe61ac19a2d0377a46ef48499eb292e12ae5fb.tar.gz nvim-treesitter-cabe61ac19a2d0377a46ef48499eb292e12ae5fb.tar.bz2 nvim-treesitter-cabe61ac19a2d0377a46ef48499eb292e12ae5fb.tar.lz nvim-treesitter-cabe61ac19a2d0377a46ef48499eb292e12ae5fb.tar.xz nvim-treesitter-cabe61ac19a2d0377a46ef48499eb292e12ae5fb.tar.zst nvim-treesitter-cabe61ac19a2d0377a46ef48499eb292e12ae5fb.zip | |
update docs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/nvim-treesitter.txt | 46 | ||||
| -rw-r--r-- | doc/tags | 23 |
2 files changed, 29 insertions, 40 deletions
diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt index f1c278427..27e4f0bb5 100644 --- a/doc/nvim-treesitter.txt +++ b/doc/nvim-treesitter.txt @@ -91,26 +91,28 @@ A list of languages can be found at |:TSInstallInfo| List modules state for the current session. ============================================================================== -API *nvim-treesitter-api* +UTILS *nvim-treesitter-utils* -Nvim treesitter exposes extended functions to use on nodes and scopes. -you can retrieve the api with: +Nvim treesitter has some wrapper functions that you can retrieve with: > - local ts_node_api = require 'nvim-treesitter'.get_node_api() + local ts_utils = require 'nvim-treesitter.ts_utils' < Methods -get_node_text(node, bufnr) *ts_api.get_node_text* +get_node_at_cursor() *ts_utils.get_node_at_cursor* + 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_api.is_parent* +is_parent(dest, source) *ts_utils.is_parent* determines wether `dest` is a parent of `source` return a boolean -get_named_children(node) *ts_api.get_named_children* +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_api.get_next_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 @@ -118,42 +120,28 @@ get_next_node(node, allow_switch_parent, allow_next_parent) *ts_api.get_next_nod 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_api.get_previous_node* +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_api.get_next_node| but if the node is the first node. + as |ts_utils.get_next_node| but if the node is the first node. -containing_scope(node) *ts_api.containing_scope* +containing_scope(node) *ts_utils.containing_scope* return the smallest scope containing the node -parent_scope(node, cursor_pos) *ts_api.parent_scope* +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 }` - you can retrieve the cursor_pos with the buffer state -nested_scope(node, cursor_pos) *ts_api.nested_scope* +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 }` - you can retrieve the cursor_pos with the buffer state -next_scope(node) *ts_api.next_scope* +next_scope(node) *ts_utils.next_scope* return the neighbour scope of the current node -previous_scope(node) *ts_api.previous_scope* +previous_scope(node) *ts_utils.previous_scope* return the previous neighbour scope of the current node -Nvim-treesitter also provides access to the state of the current buffer: -> - local cur_buf_state = require'nvim-treesitter'.get_buf_state() - print(vim.inspect(cur_buf_state)) - --[[ - { - cursor_pos = { row = number, col = number }, (current cursor pos in the buffer) - current_node = tsnode (smallest node the cursor is on) - } - ]]-- -< - ============================================================================== FUNCTIONS *nvim-treesitter-functions* @@ -6,20 +6,21 @@ :TSInstallInfo nvim-treesitter.txt /*:TSInstallInfo* :TSModuleInfo nvim-treesitter.txt /*:TSModuleInfo* nvim-treesitter nvim-treesitter.txt /*nvim-treesitter* -nvim-treesitter-api nvim-treesitter.txt /*nvim-treesitter-api* nvim-treesitter-commands nvim-treesitter.txt /*nvim-treesitter-commands* nvim-treesitter-functions nvim-treesitter.txt /*nvim-treesitter-functions* nvim-treesitter-intro nvim-treesitter.txt /*nvim-treesitter-intro* nvim-treesitter-quickstart nvim-treesitter.txt /*nvim-treesitter-quickstart* +nvim-treesitter-utils nvim-treesitter.txt /*nvim-treesitter-utils* nvim_treesitter#foldexpr() nvim-treesitter.txt /*nvim_treesitter#foldexpr()* nvim_treesitter#statusline() nvim-treesitter.txt /*nvim_treesitter#statusline()* -ts_api.containing_scope nvim-treesitter.txt /*ts_api.containing_scope* -ts_api.get_named_children nvim-treesitter.txt /*ts_api.get_named_children* -ts_api.get_next_node nvim-treesitter.txt /*ts_api.get_next_node* -ts_api.get_node_text nvim-treesitter.txt /*ts_api.get_node_text* -ts_api.get_previous_node nvim-treesitter.txt /*ts_api.get_previous_node* -ts_api.is_parent nvim-treesitter.txt /*ts_api.is_parent* -ts_api.nested_scope nvim-treesitter.txt /*ts_api.nested_scope* -ts_api.next_scope nvim-treesitter.txt /*ts_api.next_scope* -ts_api.parent_scope nvim-treesitter.txt /*ts_api.parent_scope* -ts_api.previous_scope nvim-treesitter.txt /*ts_api.previous_scope* +ts_utils.containing_scope nvim-treesitter.txt /*ts_utils.containing_scope* +ts_utils.get_named_children nvim-treesitter.txt /*ts_utils.get_named_children* +ts_utils.get_next_node nvim-treesitter.txt /*ts_utils.get_next_node* +ts_utils.get_node_at_cursor nvim-treesitter.txt /*ts_utils.get_node_at_cursor* +ts_utils.get_node_text nvim-treesitter.txt /*ts_utils.get_node_text* +ts_utils.get_previous_node nvim-treesitter.txt /*ts_utils.get_previous_node* +ts_utils.is_parent nvim-treesitter.txt /*ts_utils.is_parent* +ts_utils.nested_scope nvim-treesitter.txt /*ts_utils.nested_scope* +ts_utils.next_scope nvim-treesitter.txt /*ts_utils.next_scope* +ts_utils.parent_scope nvim-treesitter.txt /*ts_utils.parent_scope* +ts_utils.previous_scope nvim-treesitter.txt /*ts_utils.previous_scope* |
