0

0

如何利用VSCode的API为自己的扩展插件添加上下文菜单和命令面板入口?

夢幻星辰

夢幻星辰

发布时间:2025-10-10 16:53:01

|

479人浏览过

|

来源于php中文网

原创

首先在 package.json 的 contributes.commands 中声明命令,使其出现在命令面板;接着在 extension.js 中通过 vscode.commands.registerCommand 注册对应功能逻辑;然后通过 contributes.menus 配置上下文菜单,如 explorer/context 或 editor/context,并可使用 when 条件控制显示时机;最后合理利用 category、group 和 arguments 提升用户体验。整个过程以声明式配置为主,结合命令注册实现功能集成。

如何利用vscode的api为自己的扩展插件添加上下文菜单和命令面板入口?

要在 VSCode 中为自己的扩展插件添加上下文菜单和命令面板入口,主要通过 package.json 的配置和使用 VSCode 扩展 API 来实现。整个过程不需要直接调用底层 API 注册菜单项,而是通过声明式配置结合注册命令完成。

1. 在 package.json 中定义命令

所有命令必须先在 package.jsoncontributes.commands 字段中声明,这是命令出现在命令面板(Command Palette)的前提。

{ "contributes": { "commands": [ { "command": "myExtension.sayHello", "title": "Say Hello", "category": "My Extension" } ] } }

title 是显示名称,category 会在命令面板中作为前缀(如 My Extension: Say Hello),帮助用户分类识别。

2. 注册命令并实现功能

在主文件 extension.js(或 extension.ts)中使用 vscode.commands.registerCommand 注册对应逻辑。

const vscode = require('vscode'); function activate(context) { let disposable = vscode.commands.registerCommand('myExtension.sayHello', () => { vscode.window.showInformationMessage('Hello from your extension!'); }); context.subscriptions.push(disposable); } module.exports = { activate };

这样,命令“myExtension.sayHello”就被激活,并可在命令面板中执行。

CodeBuddy
CodeBuddy

腾讯云AI代码助手

下载

3. 添加上下文菜单入口

通过 contributes.menus 配置,将命令添加到右键菜单。常用的位置包括资源管理器、编辑器、编辑器标签等。

"contributes": { "menus": { "explorer/context": [ { "command": "myExtension.sayHello", "when": "resourceFilename == *.js" } ], "editor/context": [ { "command": "myExtension.sayHello", "group": "navigation" } ] } }

说明:

  • explorer/context:在资源管理器中右键文件时显示。
  • editor/context:在代码编辑器中右键时显示。
  • when:控制菜单项何时可见,例如只对 JS 文件显示。
  • group:控制菜单中的分组顺序,如 navigation、clipboard 等。

4. 常见场景与建议

为了让用户体验更自然,可以:

  • 使用 arguments 向命令传递上下文数据,比如选中的文件路径。
  • 结合 vscode.Urivscode.workspace 获取文件内容或路径。
  • when 条件中使用标准上下文变量,如 resourceScheme == fileeditorTextFocus 等。
  • 避免在高频菜单(如 editor/context)中添加过多项,合理分组。

基本上就这些。只要在 package.json 正确声明命令和菜单位置,并在主模块注册回调函数,VSCode 就会自动处理界面集成。不复杂但容易忽略的是 when 条件和 category 的使用,合理设置能让插件更专业易用。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

419

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

535

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

466

2023.11.27

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

531

2023.09.20

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

514

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

244

2023.07.28

java入门学习合集
java入门学习合集

本专题整合了java入门学习指南、初学者项目实战、入门到精通等等内容,阅读专题下面的文章了解更多详细学习方法。

1

2026.01.29

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
nginx浅谈
nginx浅谈

共15课时 | 0.8万人学习

PHP基础入门课程
PHP基础入门课程

共33课时 | 2万人学习

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

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