Files
neovim/test/functional/treesitter/node_spec.lua
David Balatero 7ed5609439 fix(treesitter): get_node_text() inconsistent trailing newline #39409
Problem:
`get_node_text()` returned inconsistent results between buffer and
string sources when a node's range ends at `end_col == 0` (i.e. the node
ends with a newline). The buffer path dropped the trailing newline; the
string path included it correctly.

Solution:
Append `'\n'` in `buf_range_get_text()` when `end_col == 0` and
`start_row ~= end_row`. The `start_row ~= end_row` guard excludes
zero-width nodes at column 0, which should return `""`.

Remove the workaround in the `#trim!` directive that manually
compensated for the missing newline.

Strip whitespace in `resolve_lang()` so injection language nodes ending
at `end_col == 0` (e.g. `">lua\n"`) still resolve correctly.
2026-05-03 09:23:32 -04:00

269 lines
7.4 KiB
Lua

local t = require('test.testutil')
local n = require('test.functional.testnvim')()
local clear = n.clear
local eq = t.eq
local exec_lua = n.exec_lua
local insert = n.insert
local assert_alive = n.assert_alive
before_each(clear)
local function lua_eval(lua_expr)
return exec_lua('return ' .. lua_expr)
end
describe('treesitter node API', function()
it('double free tree', function()
insert('F')
exec_lua(function()
vim.treesitter.start(0, 'lua')
vim.treesitter.get_parser(0):parse()
vim.treesitter.get_node():tree()
vim.treesitter.get_node():tree()
collectgarbage()
end)
assert_alive()
end)
it('double free tree 2', function()
exec_lua(function()
local parser = vim.treesitter.get_parser(0, 'c')
local x = parser:parse()[1]:root():tree()
vim.api.nvim_buf_set_text(0, 0, 0, 0, 0, { 'y' })
parser:parse()
vim.api.nvim_buf_set_text(0, 0, 0, 0, 1, { 'z' })
parser:parse()
collectgarbage()
x:root()
end)
assert_alive()
end)
it('get_node() with lang given', function()
-- this buffer doesn't have filetype set!
insert('local foo = function() end')
exec_lua(function()
vim.treesitter.get_parser(0, 'lua'):parse()
_G.node = vim.treesitter.get_node({
bufnr = 0,
pos = { 0, 6 }, -- on "foo"
lang = 'lua',
})
end)
eq('foo', lua_eval('vim.treesitter.get_node_text(node, 0)'))
eq('identifier', lua_eval('node:type()'))
end)
it('get_node() with anonymous nodes included', function()
insert([[print('test')]])
exec_lua(function()
_G.parser = vim.treesitter.get_parser(0, 'lua')
_G.tree = _G.parser:parse()[1]
_G.node = vim.treesitter.get_node({
bufnr = 0,
pos = { 0, 6 }, -- on the first apostrophe
include_anonymous = true,
})
end)
eq("'", lua_eval('node:type()'))
eq(false, lua_eval('node:named()'))
end)
it('can move between siblings', function()
insert([[
int main(int x, int y, int z) {
return x + y * z
}
]])
exec_lua(function()
local parser = assert(vim.treesitter.get_parser(0, 'c'))
local tree = parser:parse()[1]
_G.root = tree:root()
vim.treesitter.language.inspect('c')
function _G.node_text(node)
return vim.treesitter.get_node_text(node, 0)
end
end)
exec_lua 'node = root:descendant_for_range(0, 9, 0, 14)'
eq('int x', lua_eval('node_text(node)'))
exec_lua 'node = node:next_sibling()'
eq(',', lua_eval('node_text(node)'))
exec_lua 'node = node:next_sibling()'
eq('int y', lua_eval('node_text(node)'))
exec_lua 'node = node:prev_sibling()'
eq(',', lua_eval('node_text(node)'))
exec_lua 'node = node:prev_sibling()'
eq('int x', lua_eval('node_text(node)'))
exec_lua 'node = node:next_named_sibling()'
eq('int y', lua_eval('node_text(node)'))
exec_lua 'node = node:prev_named_sibling()'
eq('int x', lua_eval('node_text(node)'))
end)
it('can retrieve the children of a node', function()
insert([[
int main() {
int x = 3;
}]])
local len = exec_lua(function()
local tree = vim.treesitter.get_parser(0, 'c'):parse()[1]
local node = assert(tree:root():child(0))
_G.children = node:named_children()
return #_G.children
end)
eq(3, len)
eq('<node compound_statement>', lua_eval('tostring(children[3])'))
end)
it('can retrieve the tree root given a node', function()
insert([[
int main() {
int x = 3;
}]])
exec_lua(function()
local tree = vim.treesitter.get_parser(0, 'c'):parse()[1]
_G.root = tree:root()
_G.node = _G.root:child(0):child(2)
end)
eq(lua_eval('tostring(root)'), lua_eval('tostring(node:root())'))
end)
it('can compute the byte length of a node', function()
insert([[
int main() {
int x = 3;
}]])
exec_lua(function()
local tree = vim.treesitter.get_parser(0, 'c'):parse()[1]
_G.root = tree:root()
_G.child = _G.root:child(0):child(0)
end)
eq(28, lua_eval('root:byte_length()'))
eq(3, lua_eval('child:byte_length()'))
end)
it('child_with_descendant() works', function()
insert([[
int main() {
int x = 3;
}]])
exec_lua(function()
local tree = vim.treesitter.get_parser(0, 'c'):parse()[1]
_G.root = assert(tree:root())
_G.main = assert(_G.root:child(0))
_G.body = assert(_G.main:child(2))
_G.statement = assert(_G.body:child(1))
_G.declarator = assert(_G.statement:child(1))
_G.value = assert(_G.declarator:child(1))
end)
eq(lua_eval('main:type()'), lua_eval('root:child_with_descendant(value):type()'))
eq(lua_eval('body:type()'), lua_eval('main:child_with_descendant(value):type()'))
eq(lua_eval('statement:type()'), lua_eval('body:child_with_descendant(value):type()'))
eq(lua_eval('declarator:type()'), lua_eval('statement:child_with_descendant(value):type()'))
eq(lua_eval('value:type()'), lua_eval('declarator:child_with_descendant(value):type()'))
eq(vim.NIL, lua_eval('value:child_with_descendant(value)'))
end)
it('gets all children with a given field name', function()
insert([[
function foo(a,b,c)
end
]])
exec_lua(function()
local tree = vim.treesitter.get_parser(0, 'lua'):parse()[1]
_G.parameters_node = assert(tree:root():named_descendant_for_range(0, 18, 0, 18))
_G.children_by_field = _G.parameters_node:field('name')
end)
eq('parameters', lua_eval('parameters_node:type()'))
eq(3, lua_eval('#children_by_field'))
eq('a', lua_eval('vim.treesitter.get_node_text(children_by_field[1], 0)'))
eq('b', lua_eval('vim.treesitter.get_node_text(children_by_field[2], 0)'))
eq('c', lua_eval('vim.treesitter.get_node_text(children_by_field[3], 0)'))
end)
it('node access after tree edit', function()
insert([[
function x()
return true
end
]])
exec_lua(function()
local tree = vim.treesitter.get_parser(0, 'lua'):parse()[1]
-- ensure treesitter does not try to edit the tree inplace
tree:copy()
local node = tree:root():child(0)
vim.api.nvim_buf_set_lines(0, 1, 2, false, {})
vim.schedule(function()
collectgarbage()
local a, b, c, d = node:range()
_G.range = { a, b, c, d }
end)
end)
eq({ 0, 0, 2, 3 }, lua_eval('range'))
end)
it(
'get_node_text() includes trailing newline for buffer source when node end_col == 0',
function()
insert('local x = 1')
exec_lua(function()
_G.node = vim.treesitter.get_parser(0, 'lua'):parse()[1]:root()
end)
eq('local x = 1\n', lua_eval('vim.treesitter.get_node_text(_G.node, 0)'))
end
)
it(
'get_node_text() includes trailing newline for string source when node end_col == 0',
function()
exec_lua(function()
local source = 'local x = 1\n'
_G.source = source
_G.node = vim.treesitter.get_string_parser(source, 'lua'):parse()[1]:root()
end)
eq('local x = 1\n', lua_eval('vim.treesitter.get_node_text(_G.node, _G.source)'))
end
)
it('tree:root() is idempotent', function()
insert([[
function x()
return true
end
]])
exec_lua(function()
local tree = vim.treesitter.get_parser(0, 'lua'):parse()[1]
assert(tree:root() == tree:root())
assert(tree:root() == tree:root():tree():root())
end)
end)
end)