0

0

VSCode的命令与菜单贡献点详解

P粉986688829

P粉986688829

发布时间:2026-01-02 16:55:10

|

116人浏览过

|

来源于php中文网

原创

需在package.json中注册commands并配置menus,command须全局唯一,menus按menu ID(如file、editor/context)分组,支持when条件与args参数传递,调试需用开发者工具验证。

vscode的命令与菜单贡献点详解

如果您在开发过程中需要自定义 VSCode 的命令行为或扩展其菜单选项,则需深入理解命令(commands)与菜单贡献点(menu contributions)的注册机制和作用范围。以下是针对该主题的详细说明:

本文运行环境:MacBook Pro,macOS Sequoia。

一、命令贡献点的定义与注册

命令是 VSCode 扩展中可被调用的功能单元,必须在 package.json 的 contributes.commands 字段中显式声明,否则无法通过命令面板触发或绑定快捷键。

1、在扩展根目录的 package.json 文件中定位到 contributes 字段。

2、在 contributes 对象内添加 commands 数组,每个数组项为一个对象,包含 command、title 和可选的 category 属性。

3、command 字符串必须全局唯一,推荐采用小写字母加连字符格式,例如 my-extension.format-code

4、title 用于命令面板中显示的中文或英文描述,支持本地化字符串引用,如 %commands.formatCode%。

二、主菜单栏贡献点配置

主菜单栏(即顶部 File、Edit、View 等区域)的扩展项需通过 menus 字段下的 menu 字段声明,目标位置由 id 指定,例如 file、edit、selection。

1、在 package.json 的 contributes.menus 对象下新增 menu 键,值为对象类型。

2、在该对象中指定预定义菜单 ID,如 "file" 表示文件菜单,"edit" 表示编辑菜单。

3、对应 ID 的值为数组,每个元素包含 command(已注册的命令 ID)、when(条件表达式)和 group(排序分组名)。

4、group 值如 navigation、modification 可影响菜单项相对位置,navigation 组默认置于菜单前部,modification 组默认置于后部。

三、编辑器上下文菜单贡献点配置

编辑器右键菜单的扩展依赖于 editor/context 菜单 ID,其触发逻辑与当前光标所在编辑器状态强相关,支持细粒度的 when 条件控制。

1、在 contributes.menus.editor/context 下添加条目数组。

SEEK.ai
SEEK.ai

AI驱动的智能数据解决方案,询问您的任何数据并立即获得答案

下载

2、每个条目需指定 command,且该 command 必须已在 contributes.commands 中注册。

3、when 条件可使用 resourceLangId、editorTextFocus、editorHasSelection 等上下文键,例如 editorTextFocus && resourceLangId == 'javascript' 限定仅在 JavaScript 文件聚焦时显示。

4、支持嵌套子菜单,通过 submenu 字段引用另一个已声明的菜单 ID,并在该 submenu 对应的 menus 下定义其子项。

四、命令执行时的参数传递机制

VSCode 允许在菜单项或快捷键绑定中向命令传递参数,参数将在 activate 函数中以 executeCommand 的第二个及以上参数形式接收。

1、在 menus 条目中添加 args 字段,值为 JSON 序列化的任意结构,如 [true, "default"] 或 {"mode": "strict"}。

2、在 extension.ts 的 registerCommand 回调函数中,参数列表将按顺序接收 args 内容,第一个参数始终为命令触发时的上下文对象。

3、args 中若含变量占位符,如 $selectedText 或 $fileBasename,需确保 when 条件中已启用对应上下文,否则值为空字符串。

4、args 不支持函数或 undefined 值,传入将导致命令执行失败且无错误提示

五、调试菜单与命令可见性的验证方法

菜单项是否正常渲染、命令能否被识别,需借助 VSCode 内置的开发者工具进行实时校验,避免仅依赖静态配置检查。

1、在扩展开发窗口中按下 Cmd+Shift+P(macOS)打开命令面板。

2、输入 Developer: Toggle Developer Tools,打开浏览器开发者控制台。

3、在控制台中执行 vscode.commands.getCommands(true) 查看当前所有已注册命令列表。

4、右键编辑器任意位置,选择 Inspect Context Menu,查看 DOM 中是否渲染出对应 menuitem 元素及其 disabled 属性状态。

热门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

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

784

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

435

2024.06.27

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

298

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

212

2023.09.04

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

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

1

2026.01.29

热门下载

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

精品课程

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

共58课时 | 4.3万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.1万人学习

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

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