确认 hover 提示是否注册成功需先检查 Developer: Inspect Editor Tokens and Scopes 中 languageId 是否与 registerHoverProvider 传入的一致,并核对状态栏语言模式是否匹配,同时排查 activationEvents、文件排除、LSP 就绪状态等常见问题。

怎么确认插件的 hover 提示是否注册成功
VSCode 插件里的 hover 功能由 vscode.languages.registerHoverProvider 注册,但注册后不等于能立刻看到效果——它只在语言 ID 匹配、光标落在有效 token 上时才触发。常见现象是改完代码、重载插件,悬停却没反应。
验证方法:打开命令面板(Ctrl+Shift+P),运行 Developer: Inspect Editor Tokens and Scopes,把鼠标悬停在目标代码上,看右上角弹出的浮层里 languageId 是否和你在 registerHoverProvider 里传入的一致(比如不是 javascript 而是 typescriptreact);再检查状态栏右下角显示的语言模式是否匹配。
容易踩的坑:
- 语言 ID 写错或大小写不符,例如用
js代替javascript - 注册时传了空数组或未返回
vscode.Hover实例(返回null或undefined会被静默忽略) - 插件激活事件没等
onLanguage:xxx就提前注册,导致 provider 没挂上
hover 提示内容为空或格式错乱怎么办
vscode.Hover 构造器接受 MarkdownString 或 string,但只有 MarkdownString 支持渲染链接、代码块、换行等;若直接传普通字符串,所有 Markdown 符号(如 **、`)都会原样显示,看着像“乱码”。
实操建议:
- 用
new vscode.MarkdownString(text, true)初始化,第二个参数true表示启用isTrusted,否则链接不跳转、代码块不高亮 - 避免在 hover 回调里做异步耗时操作(比如
fetch或读大文件),会卡住整个悬停响应,用户看到的是空白或延迟数秒 - 修改了 hover 内容逻辑后,必须保存插件源码并执行
Developer: Reload Window,热重载(Ctrl+R)通常不刷新 hover provider
为什么调试时断点进不去 hover 回调函数
hover 是懒加载触发的:只有当用户真正悬停且满足语言 ID + token 范围匹配时,VSCode 才调用你的 provider。断点设在回调里却从不命中,大概率是前面两个条件没满足。
排查步骤:
- 在 provider 函数最开头加
console.log('hover triggered'),然后打开开发者工具(Ctrl+Shift+I→ Console 标签),悬停时看有没有输出 - 确保插件
package.json的activationEvents包含对应语言,例如"onLanguage:javascript",否则插件根本没激活 - 检查当前文件是否被排除在工作区外(比如在
files.watcherExclude里),VSCode 不会对被排除路径下的文件触发 LSP 相关功能
如何模拟真实悬停行为做自动化测试
VSCode 官方不提供 hover 的单元测试 API,但可以用集成测试方式逼近真实场景:启动一个测试用 VSCode 实例,打开目标文件,用 Puppeteer 或 vscode-test 控制光标位置并捕获 hover 内容。
更轻量的替代方案:
- 把 hover 逻辑抽成纯函数(接收
document,position,token,返回vscode.Hover),单独对它写单元测试 - 在 provider 回调里,先判断
process.env.VSCODE_ENV === 'test',如果是则跳过异步请求,直接返回预置的 mock 数据 - 注意:hover 内容不会自动更新——修改源码注释或配置后,必须手动保存文件,VSCode 才会重新解析并刷新提示


















