Dart SDK 中集成 VSCode 编辑器设置到诊断报告的技术实现

在 Dart 语言开发工具链的持续优化过程中，开发团队发现编辑器保存时的自动格式化（formatOnSave）和代码修复（codeActionsOnSave）等操作可能会影响性能表现。为了更有效地分析这些潜在的性能影响因素，团队决定将 VSCode 编辑器相关配置纳入 Dart 分析服务器的诊断报告中。

背景与挑战

传统的诊断报告主要收集分析服务器本身的运行数据，而编辑器客户端的配置信息往往处于黑盒状态。当用户遇到性能问题时，开发团队难以判断是否与特定编辑器设置相关。本次改进需要解决几个关键技术问题：

1. 配置获取方式：需要确定是通过完整配置请求还是针对性获取特定设置项
2. 语言作用域配置：如何处理针对 Dart 语言的特定覆盖设置
3. 数据实时性：确保收集的配置信息能够反映用户的最新设置
4. 跨平台兼容性：解决方案需要适应不同的编辑器环境

技术方案演进

经过多次讨论和技术验证，团队最终确定了以下技术路线：

1. 初期探索：尝试直接通过 LSP 协议获取编辑器配置，发现存在以下限制：

   • 无法直接获取语言作用域下的覆盖配置（如 [dart] 区块中的设置）
   • 现有中间件处理逻辑对非对象类型配置支持不足

2. 方案优化：转向通过 Dart-Code 扩展收集配置信息，采用两种主要方式：

   • 在初始化参数中嵌入配置数据
   • 通过客户端能力（ClientCapabilities）的 experimental 字段传递

3. 最终实现：建立了专用的诊断信息通道：

   • 使用自定义通知机制确保配置变更实时更新
   • 在客户端能力中创建 diagnosticInfo 专用字段
   • 支持全局和工作区级别的配置收集

实现细节

实际实现包含以下关键技术点：

1. 数据结构设计：

"experimental": {
  "diagnosticInfo": {
    "settings": {
      "global": {
        "editor.formatOnSave": true
      },
      "workspaceFolders": [
        {
          "editor.formatOnSave": false
        }
      ]
    }
  }
}

2. 实时更新机制：

   • 监听 LSP 的 configurationDidChange 通知
   • 在设置变更时主动推送更新到分析服务器

3. 异常处理：

   • 兼容旧版扩展的中间件限制
   • 处理配置获取失败的情况

技术价值

这项改进为 Dart 开发工具链带来了显著提升：

1. 诊断能力增强：现在可以关联性能问题与特定编辑器配置
2. 问题定位效率：减少了对用户手动提供配置信息的依赖
3. 架构扩展性：为未来收集更多客户端信息建立了标准化通道
4. 用户体验优化：帮助团队更精准地识别和解决性能瓶颈

实际应用

开发者现在可以在 Dart 分析器诊断页面中直观看到：

• 全局和工作区级别的 formatOnSave 设置状态
• 代码修复操作的保存时配置
• 其他相关编辑器偏好设置

这些信息会同时显示在诊断页面和导出的报告中，为问题排查提供了重要上下文。

这项改进体现了 Dart 团队对开发者体验的持续关注，通过技术创新不断优化工具链的透明度和可调试性。未来团队还计划基于这个框架收集更多有价值的诊断信息，进一步提升问题解决效率。