You need to enable JavaScript to run this app. VS Code扩展开发:语法检查时如何为错误输入单词显示波浪错误下划线(squiggles)?
优惠活动
大模型
产品
解决方案
定价
更多

VS Code扩展开发:语法检查时如何为错误输入单词显示波浪错误下划线(squiggles)?

实现VS Code扩展错误波浪下划线(Squiggles)的方法

首先明确核心逻辑:你当前使用的内容着色属于自定义文本装饰(TextEditorDecorationType)能力,仅能修改文字本身的显示样式;而错误提示的波浪下划线是VS Code原生诊断(Diagnostics)体系的内置渲染能力,无法通过自定义文字着色实现,需要按照诊断体系的流程开发。

具体实现步骤

  • 初始化诊断集合
    在扩展激活阶段,创建全局可管理的诊断集合实例,这个集合是VS Code统一承接所有文件错误、警告提示的官方载体:
    const checkerDiagnostics = vscode.languages.createDiagnosticCollection('my-syntax-checker');
    
    记得把这个实例加入扩展的可释放资源列表,避免内存泄漏。
  • 绑定文档变动监听
    注册vscode.workspace.onDidChangeTextDocument事件,当用户输入、文档内容发生变动时,自动触发拼写/语法检查逻辑,逐行扫描文档文本定位错误位置。
  • 构造带错误标记的诊断对象
    针对扫描到的错误内容(比如示例中输入的错误单词frm),生成对应的Diagnostic实例,核心参数包括:
    • 用vscode.Range精准框选错误内容的起止位置,确保下划线完全覆盖错误单词
    • 填写面向用户的错误提示信息
    • 选择诊断严重等级,指定为vscode.DiagnosticSeverity.Error时,VS Code会自动在对应位置渲染默认的红色波浪错误下划线
  • 绑定诊断结果到对应文档
    完成单文档的错误扫描后,调用checkerDiagnostics.set(文档URI, 扫描到的所有诊断实例数组),VS Code接收到结果后会自动完成波浪线渲染,无需手动实现绘制逻辑。

常见开发误区

不要尝试通过自定义文本装饰的textDecoration、border属性手动模拟波浪效果:这类自定义装饰不会和VS Code的问题面板、悬浮提示、快速修复能力联动,体验远低于原生诊断的渲染效果。
如果需要自定义波浪线的颜色,不需要修改诊断逻辑,只需要在扩展配置中调整editorError.foreground、editorWarning.foreground等原生主题配置项即可。

最小可运行代码示例

export function activate(context: vscode.ExtensionContext) {
  // 初始化语法检查诊断集合
  const syntaxChecker = vscode.languages.createDiagnosticCollection('syntax-checker');
  context.subscriptions.push(syntaxChecker);

  // 监听文档输入变动
  context.subscriptions.push(
    vscode.workspace.onDidChangeTextDocument(event => {
      const doc = event.document;
      const errorList: vscode.Diagnostic[] = [];

      // 逐行扫描全文档
      for (let lineNo = 0; lineNo < doc.lineCount; lineNo++) {
        const currentLine = doc.lineAt(lineNo);
        // 检测错误单词frm
        const matchResult = currentLine.text.match(/\bfrm\b/);
        if (matchResult) {
          // 定位错误单词的文本范围
          const errorStart = new vscode.Position(lineNo, matchResult.index);
          const errorEnd = errorStart.translate(0, matchResult[0].length);
          const errorRange = new vscode.Range(errorStart, errorEnd);
          // 生成错误诊断,自动触发波浪下划线渲染
          const errorDiag = new vscode.Diagnostic(
            errorRange,
            '疑似输入错误,正确写法为 from',
            vscode.DiagnosticSeverity.Error
          );
          errorList.push(errorDiag);
        }
      }

      // 将诊断结果同步给VS Code
      syntaxChecker.set(doc.uri, errorList);
    })
  );
}

内容的提问来源于stack exchange,提问作者akhil

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.11.05 09:15:00