Neovim插件问题：TextChange/Undo无法触发Clear_highlights函数

我最近在用Neovim开发一款基础插件，用来更新package.json中的Node模块包。需求是当文本变更（比如输入修改）或执行撤销操作时，自动调用Clear_highlights函数清除缓冲区命名空间的高亮。目前手动执行:lua Clear_highlights()能正常生效，但文本变更或撤销时完全触发不了这个函数，求帮忙排查问题。

相关代码：

-- Clear buffer
Clear_highlights = function()
    vim.api.nvim_buf_clear_namespace(0, require("nodePackageCheck").Config.get_namespace_id(), 0, -1)
end

vim.cmd([[autocmd! TextChanged,TextChangedI, BufWritePost  * lua Clear_highlights()]])

问题排查与修复方案 #

1. 事件格式错误 + 缺失撤销事件
   你的autocmd事件列表存在两个关键问题：

   • TextChangedI, BufWritePost中逗号后多了空格，Neovim会将带空格的字符串识别为无效事件名，导致BufWritePost等事件无法触发
   • 撤销操作对应的事件是TextChangedUndo，你未添加该事件，所以撤销时不会触发清除高亮逻辑

2. 改用Lua原生API替代vim.cmd
   使用vim.api.nvim_create_autocmd和augroup更符合Neovim现代开发规范，能避免字符串解析带来的问题，同时给autocmd分组可防止与其他插件冲突。

修正后的代码：

-- 定义局部函数，避免污染全局命名空间
local function Clear_highlights()
    local ns_id = require("nodePackageCheck").Config.get_namespace_id()
    vim.api.nvim_buf_clear_namespace(0, ns_id, 0, -1)
end

-- 创建专属autocmd分组，避免冲突
vim.api.nvim_create_augroup("NodePackageCheckHighlights", { clear = true })
-- 注册需要的事件，注意事件间无多余空格，新增TextChangedUndo处理撤销
vim.api.nvim_create_autocmd({ "TextChanged", "TextChangedI", "TextChangedUndo", "BufWritePost" }, {
    group = "NodePackageCheckHighlights",
    pattern = "package.json", -- 建议限制只在package.json触发，更精准高效
    callback = Clear_highlights,
})

额外建议 #

• 可在Clear_highlights中添加print("Highlights cleared")调试，确认事件触发时函数是否执行
• 优先限制触发范围，将pattern设为"package.json"而非"*"，避免在所有文件中不必要地执行逻辑
• 尽量避免使用全局函数，改用局部函数+autocmd callback的方式，符合Neovim插件开发最佳实践

内容的提问来源于stack exchange，提问作者Aziz.G