mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-06-17 09:11:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(vim.hl): range(0,…) highlight not cleared after buffer-switch #40130

Browse Source 
Problem:
When `vim.hl.range(0, …, { timeout = N })` is called, the deferred
`range_hl_clear` captures `buf=0`, which resolves to an arbitrary
"current buffer" at timeout. This may cause a stale highlight that never
gets cleared.

Solution:
Resolve `buf=0` explicitly, before `range_hl_clear` captures it.

(cherry picked from commit ec7dab077b)
This commit is contained in:
Justin M. Keyes
2026-06-06 06:26:12 -04:00
committed by github-actions[bot]
parent 3a3405d964
commit be4e7cfd6a
2 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
runtime/lua/vim/hl.lua
View File

@@ -49,6 +49,8 @@ M.priorities = {
--- @return fun()? range_clear A function which allows clearing the highlight manually. --- @return fun()? range_clear A function which allows clearing the highlight manually.
--- nil is returned if timeout is not specified --- nil is returned if timeout is not specified
function M.range(buf, ns, higroup, start, finish, opts) function M.range(buf, ns, higroup, start, finish, opts)
-- Resolve buf=0 so the deferred `range_hl_clear` works correctly even after buffer-switch.
buf = vim._resolve_bufnr(buf)
opts = opts or {} opts = opts or {}
local regtype = opts.regtype or 'v' local regtype = opts.regtype or 'v'
local inclusive = opts.inclusive or false local inclusive = opts.inclusive or false

15
test/functional/lua/hl_spec.lua
View File

@@ -113,7 +113,7 @@ describe('vim.hl.range', function()
]]) ]])
end) end)
it('removes highlight after given `timeout`', function() it('removes highlight after `timeout`', function()
local timeout = 300 local timeout = 300
exec_lua(function() exec_lua(function()
local ns = vim.api.nvim_create_namespace('') local ns = vim.api.nvim_create_namespace('')
@@ -130,6 +130,13 @@ describe('vim.hl.range', function()
]], ]],
timeout = timeout / 3, timeout = timeout / 3,
}) })
-- The deferred `range_hl_clear` works even if a different buffer was switched-to.
exec_lua(function()
local orig = vim.api.nvim_get_current_buf()
vim.api.nvim_set_current_buf(vim.api.nvim_create_buf(false, true))
vim.wait(timeout * 2)
vim.api.nvim_set_current_buf(orig)
end)
screen:expect([[ screen:expect([[
^asdfghjkl{1:$} | ^asdfghjkl{1:$} |
«口=口»{1:$} | «口=口»{1:$} |
@@ -180,7 +187,7 @@ describe('vim.hl.range', function()
]]) ]])
end) end)
it('allows cancelling a highlight that has not timed out', function() it('allows cancelling a highlight before timeout', function()
exec_lua(function() exec_lua(function()
local timeout = 3000 local timeout = 3000
local range_timer local range_timer
@@ -220,7 +227,7 @@ describe('vim.hl.on_yank', function()
clear() clear()
end) end)
it('does not show errors even if buffer is wiped before timeout', function() it('no errors even if buffer is wiped before timeout', function()
command('new') command('new')
n.feed('ifoo<esc>') -- set '[, '] n.feed('ifoo<esc>') -- set '[, ']
exec_lua(function() exec_lua(function()
@@ -265,7 +272,7 @@ describe('vim.hl.on_yank', function()
end) end)
end) end)
it('removes old highlight if new one is created before old one times out', function() it('removes old highlight if new one is created before old timeout', function()
command('vnew') command('vnew')
exec_lua(function() exec_lua(function()
vim.api.nvim_buf_set_mark(0, '[', 1, 1, {}) vim.api.nvim_buf_set_mark(0, '[', 1, 1, {})