VSCode快速修复提供者开发-VSCode-PHP中文网

VSCode快速修复提供者开发

夢幻星辰

发布： 2025-10-20 15:00:03

原创

617人浏览过

实现快速修复需注册CodeActionProvider，监听诊断问题并返回CodeAction，支持TextEdit或WorkspaceEdit。

vscode快速修复提供者开发

在 VSCode 中开发“快速修复”功能，本质是实现一个 代码操作（Code Action）提供者，用于响应用户在编辑器中遇到的问题并提供自动修复建议。这通常配合语言服务器（Language Server）使用，也可以直接在普通扩展中实现。

理解快速修复机制

VSCode 的“快速修复”（Quick Fix）功能通过灯泡图标提示用户可执行的操作，比如修复语法错误、导入缺失模块、转换代码格式等。要实现这个功能，你需要注册一个 CodeActionProvider。

关键点：

监听特定诊断问题（由 Diagnostics 提供）
返回带有修复动作的 CodeAction 对象
支持编辑（TextEdit）、命令（Command）或工作区编辑（WorkspaceEdit）

注册快速修复提供者

在扩展的 activationEvents 中触发，并在 activate 函数中注册提供者：

// extension.ts
import * as vscode from 'vscode';
<p>export function activate(context: vscode.ExtensionContext) {
const provider = new MyQuickFixProvider();
context.subscriptions.push(
vscode.languages.registerCodeActionsProvider('javascript', provider, {
providedCodeActionKinds: [vscode.CodeActionKind.QuickFix]
})
);
}</p>

登录后复制

MyQuickFixProvider 需要实现 provideCodeActions 方法：

class MyQuickFixProvider implements vscode.CodeActionProvider {
  provideCodeActions(
    document: vscode.TextDocument,
    range: vscode.Range | vscode.Selection,
    context: vscode.CodeActionContext,
    token: vscode.CancellationToken
  ): vscode.CodeAction[] {
    // 只对包含诊断的问题行响应
    const diagnostics = context.diagnostics;
    const actions: vscode.CodeAction[] = [];
<pre class='brush:php;toolbar:false;'>for (const diagnostic of diagnostics) {
  if (diagnostic.message.includes('missing import')) {
    const fix = new vscode.CodeAction(
      '自动导入模块',
      vscode.CodeActionKind.QuickFix
    );
    fix.edit = new vscode.WorkspaceEdit();
    fix.edit.insert(
      document.uri,
      diagnostic.range.start.translate({ lineDelta: 0, characterDelta: 0 }),
      "import { X } from 'module';\n"
    );
    actions.push(fix);
  }
}
return actions;

登录后复制

} }

结合语言服务器使用（推荐）

如果你正在开发语言服务器（通过 vscode-languageserver），可以在服务端检测问题并发送诊断信息，然后在客户端扩展中响应这些诊断来提供修复。

绘蛙AI修图

绘蛙平台AI修图工具，支持手脚修复、商品重绘、AI扩图、AI换色

129

查看详情

服务端示例（发送诊断）：

connection.onDidOpenTextDocument((params) => {
  const diagnostics: Diagnostic[] = [];
  // 检查内容是否缺少导入
  if (text.includes('X') && !text.includes('import')) {
    diagnostics.push({
      severity: DiagnosticSeverity.Warning,
      message: 'missing import for X',
      range: Range.create(0, 0, 0, 0),
      code: 'missing-import'
    });
  }
  connection.sendDiagnostics({ uri: params.textDocument.uri, diagnostics });
});

登录后复制

客户端则根据 diagnostic.code 判断是否提供对应修复。