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 下添加条目数组。

零一万物开放平台
零一万物开放平台

零一万物大模型开放平台

下载

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 属性状态。

相关专题

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

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

544

2023.06.20

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

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

372

2023.07.04

js四舍五入
js四舍五入

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

727

2023.07.04

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

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

470

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

393

2023.09.04

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

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

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

654

2023.09.12

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

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

544

2023.09.20

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

74

2025.12.31

热门下载

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

精品课程

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

共58课时 | 3.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 1.9万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.7万人学习

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

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