VSCode快速修复提供者开发

实现快速修复需注册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('j*ascript', 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),可以在服务端检测问题并发送诊断信息,然后在客户端扩展中响应这些诊断来提供修复。

游戏点卡API接口 游戏点卡API接口

点卡API支付接口支持各大游戏类一卡通接口。优势:1、同行业点卡回收支付业务更全;2、同行业点卡回收处理速度更快;3、同行业点卡回收技术更强,支持多卡同时提交;更新内容:1、增加点卡卡密规则文档,发便开发人员根据卡密位数提交前判断;2、增加点卡api接口密钥申请教程,减少在申请过程担误的时间;3、POST传值加密措施更严谨,同行业内存在多年的不足已修复完善;

游戏点卡API接口 0 查看详情 游戏点卡API接口

服务端示例(发送诊断):

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 判断是否提供对应修复。

测试与调试技巧

确保你的扩展能正确触发快速修复:

  • package.json 中声明正确的语言和激活事件
  • 使用 console.log 或调试器检查 provideCodeActions 是否被调用
  • 手动触发 Ctrl + . 查看灯泡菜单是否出现建议
  • 确认诊断信息确实由你的扩展或语言服务器发出

基本上就这些。实现一个实用的快速修复功能,核心在于精准匹配诊断问题并构造安全的编辑操作。

以上就是VSCode快速修复提供者开发的详细内容,更多请关注php中文网其它相关文章!

本文转自网络,如有侵权请联系客服删除。