VSCode插件调试之代码诊断Diagnostic信息输出

千瑶同学_9804

千瑶同学_9804

2026-09-08

679人浏览

原创

diagnostic信息不显示,首要确认语言服务器(lsp)是否真正运行并成功连接:检查output窗口对应语言通道日志、documentselector是否匹配文件后缀与语言模式、diagnostic对象字段(如range、severity)是否符合vscode.diagnostic规范,且触发时机(didchange/didsave)与客户端同步配置一致。

vscode插件调试之代码诊断diagnostic信息输出

VSCode插件里 diagnostic 信息不显示?先确认 language server 是否真在跑

Diagnostic 不是写完就自动冒出来的,它依赖 language server 进程持续运行并主动推送。如果你改了 server 代码但 Problems 面板还是空的,大概率是 server 没起来,或者 client 没连上。

常见错误现象:修改了 server/src/server.ts 中的诊断逻辑,重启 VSCode 后仍无波浪线;output 窗口里找不到对应语言通道(如 mylang)的日志。

  • 检查 client/src/extension.ts 中 documentSelector 是否匹配当前文件后缀和语言模式(比如 language: 'vue' 但文件实际是 .js)
  • 确保 server 进程启动成功:在 output 窗口切换到你的语言通道,应能看到类似 Starting language server... 或 Connection established
  • 不要用 console.log 调试 server——它默认不输出到任何可见位置;改用 connection.console.log(),内容会出现在对应 output 通道

Diagnostic 对象字段写错会导致跳转失效或静默丢弃

VSCode 只认特定结构的 vscode.Diagnostic 对象,字段名、类型、嵌套层级错一个,诊断就可能被忽略,或显示但无法点击跳转。

关键字段必须准确:

  • range 必须是 vscode.Range 实例,不能是普通对象;行号从 0 开始,列号同理
  • severity 只能是 vscode.DiagnosticSeverity.Error / Warning / Information / Hint,不能传数字或字符串
  • source 推荐设为固定字符串(如 'my-linter'),避免动态拼接导致 channel 混乱
  • 如果想支持快速修复(Quick Fix),必须额外调用 connection.sendDiagnostics() 前设置 diagnostic.code 和 diagnostic.relatedInformation(可选)

示例正确写法:

const diagnostic = new vscode.Diagnostic(
  new vscode.Range(0, 5, 0, 10),
  'Variable name must be camelCase',
  vscode.DiagnosticSeverity.Warning
);
diagnostic.source = 'my-linter';
diagnostic.code = 'naming/camelcase';

Diagnostic 报告延迟或只在保存时触发?检查触发时机配置

默认情况下,很多 language server 只在文件保存(onSave)时做一次全量诊断。输入过程中不报错,不是 bug,是配置使然。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

要实现“边输边检”,得在 server 初始化时显式声明:

  • 注册 textDocument/didChange 处理器,而不是只监听 textDocument/didSave
  • 注意性能:didChange 触发极频繁,建议加防抖(debounce),例如延迟 300ms 再执行诊断逻辑
  • 客户端也要配好:在 client/src/extension.ts 的 clientOptions.synchronize 中确保 fileEvents 包含 **/*.mylang,否则变更事件根本不会发给 server

另外,settings.json 中若存在 "mylang.validateOnSave": true,而没配 validateOnType,那必然只在保存时生效。

诊断信息出现在 output 但 Problems 面板不显示?重点查 documentSelector 和语言模式

这是最隐蔽也最常被忽略的问题:server 日志里明明打印了 diagnostic,Problems 面板却空空如也。根本原因通常是 VSCode 根本没把当前文件“分配”给你的 language server。

验证步骤:

  • 打开目标文件,看右下角状态栏语言模式是否是你注册的(比如显示 MyLang 而不是 Plain Text);如果不是,点它手动改成对应语言
  • 确认 package.json 中 contributes.languages 正确声明了该语言 ID 和文件关联(filenames, extensions, firstLine)
  • 检查 client/src/extension.ts 中 documentSelector 的 language 字段是否与 contributes.languages.id 完全一致(大小写敏感)
  • 如果用了多根工作区,确保该文件所在文件夹有独立的 .vscode/settings.json,且未通过 "files.associations" 错误覆盖语言模式

一旦 documentSelector 不匹配,VSCode 就不会把该文件的变更事件转发给你的 server,自然也不会接收 diagnostic —— 所有日志都白打。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1335

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2812

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1949

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1727

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2607

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1818

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1242

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1116

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

474

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程