0

0

VSCode代码动作提供者开发

betcha

betcha

发布时间:2025-10-28 16:04:02

|

202人浏览过

|

来源于php中文网

原创

首先注册代码动作提供者,再实现提供者接口。通过监听诊断信息(如“Missing import”),在用户提供上下文菜单时返回快速修复建议,例如自动插入导入语句,并支持分类动作如重构或源码优化,最后在开发主机中测试触发与执行效果。

vscode代码动作提供者开发

在 Visual Studio Code(简称 VSCode)中开发代码动作提供者(Code Action Provider),可以让你的扩展为用户提供上下文相关的代码修复或重构建议。这在语言服务器扩展中非常常见,比如自动导入缺失的模块、修复语法错误、优化代码结构等。

理解代码动作(Code Actions)

代码动作是用户通过右键菜单或快捷键(如 Ctrl + .)触发的一组建议操作。它们通常出现在编辑器检测到问题时,例如未使用的变量、类型错误或缺少导入。

要实现代码动作提供者,你需要注册一个 CodeActionProvider 到你的扩展中,并根据文档和诊断信息决定返回哪些动作。

注册代码动作提供者

在扩展的 extension.ts 文件中,使用 vscode.languages.registerCodeActionsProvider 方法注册提供者。你需要指定语言类型和提供者逻辑。

示例代码:

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) { const provider = new MyCodeActionProvider(); const disposable = vscode.languages.registerCodeActionsProvider('javascript', provider); context.subscriptions.push(disposable); }

实现 CodeActionProvider 接口

创建一个类实现 vscode.CodeActionProvider 接口,主要实现 provideCodeActions 方法。

该方法接收文档、范围、上下文(包含诊断信息)等参数,返回一个代码动作数组。

示例实现:

class MyCodeActionProvider implements vscode.CodeActionProvider {
    provideCodeActions(
        document: vscode.TextDocument,
        range: vscode.Range,
        context: vscode.CodeActionContext
    ): vscode.Command[] | vscode.CodeAction[] | undefined {
        // 只处理特定诊断
        const diagnostics = context.diagnostics.filter(diag => 
            diag.message.includes('Missing import')
        );
    if (!diagnostics.length) {
        return;
    }

    const action = new vscode.CodeAction(
        'Auto-import module',
        vscode.CodeActionKind.QuickFix
    );
    action.edit = new vscode.WorkspaceEdit();
    action.edit.insert(document.uri, diagnostics[0].range.start, "import { MyModule } from 'mymodule';\n");
    action.diagnostics = diagnostics;
    action.isPreferred = true;

    return [action];
}

}

上面的例子中,当检测到“Missing import”错误时,提供一个自动插入导入语句的修复动作。

海外代购系统源码
海外代购系统源码

该软件是一个以asp+access进行开发的代购企业网站源码。代购优势:随着经济全球化与互联网的发展,带动了许多新新行业,也不缺少成功的案例,淘宝只是其中的一个。而在物流行业中,像代购网站和转运网站都是非常有发展潜力的,消费者可以通过代购网站买到在国内买不到的东西,并且价格也会相对便宜,这些都是代购的优势。代购方式包括有:代购、直购、团购、秒杀、拼单等,首先由客户提交代购订单,然后进行物流选择,可

下载

使用诊断信息触发动作

代码动作通常与语言服务器发布的诊断(Diagnostic)相关联。确保你的语言服务器或文档分析逻辑能正确生成带消息和范围的诊断项。

你可以通过以下方式增强匹配精度:

  • 为诊断设置特定的 code 字段,便于识别
  • 使用正则表达式匹配错误消息
  • 结合 AST 分析定位问题根源

支持快速修复与重构

VSCode 区分不同类型的代码动作,使用 CodeActionKind 可以分类:

  • QuickFix:针对诊断的修复,如导入、删除未用变量
  • Refactor:重构建议,如提取函数、重命名
  • Source:组织导入、格式化等源码操作

例如,注册一个重构动作:

vscode.languages.registerCodeActionsProvider('javascript', provider, {
    providedCodeActionKinds: [vscode.CodeActionKind.Refactor]
});

测试与调试

在开发过程中,使用 VSCode 的扩展开发主机(F5 启动)进行测试。确保:

  • 目标文件的语言模式正确(如 JavaScript)
  • 诊断信息已显示
  • 按下 Ctrl + . 能弹出建议菜单

查看输出面板中的“Extension Host”日志,排查注册或执行异常。

基本上就这些。实现一个有效的代码动作提供者关键在于准确识别上下文,并构造清晰、安全的编辑操作。配合语言服务器协议(LSP),还能实现更复杂的跨文件重构功能。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

559

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

436

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

756

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

479

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

534

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

1091

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

659

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

554

2023.09.20

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

58

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 9.4万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 11万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号