自定义诊断提供者可通过VSCode API实现，先创建诊断集合并监听文档变化，再分析内容生成诊断项并设置到对应文档URI上，结合精准范围、严重级别、快速修复与性能优化，可有效引导团队规范。
在 VSCode 中，问题面板（Problems Panel）是开发者定位代码错误、警告和提示的重要工具。它能集中展示来自语言服务、Linter 和自定义诊断提供者的诊断信息。要真正“精通”问题面板，关键在于理解并实现自定义诊断信息提供者，让编辑器能按你的需求报告问题。
理解诊断信息的来源
VSCode 的问题面板内容主要来自以下几种机制：
- 内置语言服务：如 TypeScript/JavaScript 的语法检查。
- Linter 工具：ESLint、Pylint 等通过扩展集成后会推送诊断。
- 自定义诊断提供者：由你开发的 VSCode 扩展动态生成诊断信息。
自定义提供者适用于特定领域语言（DSL）、项目规范校验或集成私有规则引擎等场景。
实现自定义诊断提供者
要在扩展中添加诊断信息，需使用 VSCode API 中的 languages.createDiagnosticCollection 和 vscode.Diagnostic 类。
基本步骤如下：
- 创建一个诊断集合，用于管理一组诊断信息。
- 监听文档变化（如保存或编辑时触发）。
- 分析文本内容，生成对应的诊断项。
- 将诊断结果设置到指定的文档 URI 上。
const diagnosticCollection = vscode.languages.createDiagnosticCollection('myLinter');
function updateDiagnostics(document: vscode.TextDocument) {
const diagnostics: vscode.Diagnostic[] = [];
const text = document.getText();
const pattern = /TODO/g;
let match;
while ((match = pattern.exec(text))) {
const line = document.positionAt(match.index).line;
const range = new vscode.Range(line, 0, line, 100);
const diagnostic = new vscode.Diagnostic(
range,
'Avoid using TODO in production code',
vscode.DiagnosticSeverity.Warning
);
diagnostics.push(diagnostic);
}
diagnosticCollection.set(document.uri, diagnostics);
}
// 监听文档保存事件
vscode.workspace.onDidSaveTextDocument(updateDiagnostics);
// 或监听编辑过程中的变化
vscode.workspace.onDidChangeTextDocument(e => updateDiagnostics(e.document));
优化诊断体验
为了让自定义诊断更实用，注意以下几点：
- 精准定位范围：尽量将诊断范围缩小到具体字符，方便用户定位问题。
- 使用合适的严重级别：Error、Warning、Information、Hint 各司其职。
- 支持快速修复（Code Action）：配合 CodeActionProvider 提供“删除 TODO”等建议操作。
- 控制性能开销：避免在每次按键都执行复杂分析，可节流或仅在保存时运行。
- 清理过期诊断：当文档关闭或不再需要时，调用 diagnosticCollection.delete(uri) 或 clear()。
基本上就这些。掌握诊断集合的生命周期和触发时机，就能灵活控制问题面板的内容。自定义诊断不只是报错，更是引导团队遵循规范的有效手段。
