wyj/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-09-17 20:58:20 -04:00
Code Issues Packages Projects Releases Wiki Activity

feat(treesitter): show root nodes in :InspectTree (#26944)

Browse Source 
Co-authored-by: altermo <>
Co-authored-by: Jongwook Choi <wookayin@gmail.com>
This commit is contained in:
altermo 2024-02-06 21:51:53 +01:00 committed by GitHub
parent c4417ae70c
commit c0b99bb1de
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 48 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
runtime/doc/news.txt
View File

@ -225,6 +225,7 @@ The following new APIs and features were added.
• Improved error messages for query parsing.
• `:InspectTree` (|vim.treesitter.inspect_tree()|) shows node ranges in
0-based indexing instead of 1-based indexing.
• `:InspectTree` (|vim.treesitter.inspect_tree()|) shows root nodes
• |vim.ui.open()| opens URIs using the system default handler (macOS `open`,
Windows `explorer`, Linux `xdg-open`, etc.)

25
runtime/lua/vim/treesitter/dev.lua
View File

@ -43,25 +43,26 @@ local TSTreeView = {}
---
---@param node TSNode Starting node to begin traversal |tsnode|
---@param depth integer Current recursion depth
---@param field string|nil The field of the current node
---@param lang string Language of the tree currently being traversed
---@param injections table<string, TSP.Injection> Mapping of node ids to root nodes
--- of injected language trees (see explanation above)
---@param tree TSP.Node[] Output table containing a list of tables each representing a node in the tree
local function traverse(node, depth, lang, injections, tree)
local function traverse(node, depth, field, lang, injections, tree)
table.insert(tree, {
node = node,
depth = depth,
lang = lang,
field = field,
})
local injection = injections[node:id()]
if injection then
traverse(injection.root, depth, injection.lang, injections, tree)
traverse(injection.root, depth + 1, nil, injection.lang, injections, tree)
end
for child, field in node:iter_children() do
table.insert(tree, {
node = child,
field = field,
depth = depth,
lang = lang,
})
traverse(child, depth + 1, lang, injections, tree)
for child, child_field in node:iter_children() do
traverse(child, depth + 1, child_field, lang, injections, tree)
end
return tree
@ -106,7 +107,7 @@ function TSTreeView:new(bufnr, lang)
end
end)
local nodes = traverse(root, 0, parser:lang(), injections, {})
local nodes = traverse(root, 0, nil, parser:lang(), injections, {})
local named = {} ---@type TSP.Node[]
for _, v in ipairs(nodes) do

62
test/functional/treesitter/inspect_tree_spec.lua
View File

@ -26,9 +26,10 @@ describe('vim.treesitter.inspect_tree', function()
]])
expect_tree [[
(function_call ; [0, 0] - [0, 7]
name: (identifier) ; [0, 0] - [0, 5]
arguments: (arguments)) ; [0, 5] - [0, 7]
(chunk ; [0, 0] - [2, 0]
(function_call ; [0, 0] - [0, 7]
name: (identifier) ; [0, 0] - [0, 5]
arguments: (arguments))) ; [0, 5] - [0, 7]
]]
end)
@ -44,11 +45,12 @@ describe('vim.treesitter.inspect_tree', function()
feed('a')
expect_tree [[
(function_call ; [0, 0] - [0, 7]
name: (identifier) ; [0, 0] - [0, 5]
arguments: (arguments ; [0, 5] - [0, 7]
"(" ; [0, 5] - [0, 6]
")")) ; [0, 6] - [0, 7]
(chunk ; [0, 0] - [2, 0]
(function_call ; [0, 0] - [0, 7]
name: (identifier) ; [0, 0] - [0, 5]
arguments: (arguments ; [0, 5] - [0, 7]
"(" ; [0, 5] - [0, 6]
")"))) ; [0, 6] - [0, 7]
]]
end)
@ -66,16 +68,18 @@ describe('vim.treesitter.inspect_tree', function()
]])
expect_tree [[
(section ; [0, 0] - [4, 0]
(fenced_code_block ; [0, 0] - [3, 0]
(fenced_code_block_delimiter) ; [0, 0] - [0, 3]
(info_string ; [0, 3] - [0, 6]
(language)) ; [0, 3] - [0, 6]
(block_continuation) ; [1, 0] - [1, 0]
(code_fence_content ; [1, 0] - [2, 0]
(return_statement) ; [1, 0] - [1, 6]
(block_continuation)) ; [2, 0] - [2, 0]
(fenced_code_block_delimiter))) ; [2, 0] - [2, 3]
(document ; [0, 0] - [4, 0]
(section ; [0, 0] - [4, 0]
(fenced_code_block ; [0, 0] - [3, 0]
(fenced_code_block_delimiter) ; [0, 0] - [0, 3]
(info_string ; [0, 3] - [0, 6]
(language)) ; [0, 3] - [0, 6]
(block_continuation) ; [1, 0] - [1, 0]
(code_fence_content ; [1, 0] - [2, 0]
(chunk ; [1, 0] - [2, 0]
(return_statement)) ; [1, 0] - [1, 6]
(block_continuation)) ; [2, 0] - [2, 0]
(fenced_code_block_delimiter)))) ; [2, 0] - [2, 3]
]]
end)
@ -94,16 +98,18 @@ describe('vim.treesitter.inspect_tree', function()
feed('I')
expect_tree [[
(section ; [0, 0] - [4, 0] markdown
(fenced_code_block ; [0, 0] - [3, 0] markdown
(fenced_code_block_delimiter) ; [0, 0] - [0, 3] markdown
(info_string ; [0, 3] - [0, 6] markdown
(language)) ; [0, 3] - [0, 6] markdown
(block_continuation) ; [1, 0] - [1, 0] markdown
(code_fence_content ; [1, 0] - [2, 0] markdown
(return_statement) ; [1, 0] - [1, 6] lua
(block_continuation)) ; [2, 0] - [2, 0] markdown
(fenced_code_block_delimiter))) ; [2, 0] - [2, 3] markdown
(document ; [0, 0] - [4, 0] markdown
(section ; [0, 0] - [4, 0] markdown
(fenced_code_block ; [0, 0] - [3, 0] markdown
(fenced_code_block_delimiter) ; [0, 0] - [0, 3] markdown
(info_string ; [0, 3] - [0, 6] markdown
(language)) ; [0, 3] - [0, 6] markdown
(block_continuation) ; [1, 0] - [1, 0] markdown
(code_fence_content ; [1, 0] - [2, 0] markdown
(chunk ; [1, 0] - [2, 0] lua
(return_statement)) ; [1, 0] - [1, 6] lua
(block_continuation)) ; [2, 0] - [2, 0] markdown
(fenced_code_block_delimiter)))) ; [2, 0] - [2, 3] markdown
]]
end)
end)