【vscode插件开发】(二) 右键菜单激活插件

已被阅读 2891 次 | 文章分类:日常随笔 | 2022-04-08 00:15

在初识vscode插件开发(一)-工程搭建、命令运行及调试中认识了如何通过ctrl+shift+p 调用扩展命令;本节介绍如何通过添加右键菜单,执行扩展命令;包括资源管理器右键、编辑器内部右键、过滤文件类型等

1 添加右键菜单

1.1 资源管理器上下文菜单 - explorer/context

打开extension.ts,在activate函数中添加如下命令:

                                            
context.subscriptions.push(
		vscode.commands.registerCommand("GeoJsonViewer.askQuestion", async () => {
			let answer = await vscode.window.showInformationMessage("How was your day ?", "good", "bad",)
			if (answer === "bad") {
				vscode.window.showInformationMessage("sorry to hear it")
			} else {
				console.log({ answer })
			}
		})
	)
                                            
                                        

打开package.json 配置右键菜单

                                            
"contributes": {
		"commands": [
			{
				"command": "GeoJsonViewer.helloWorld",
				"title": "Hello World"
			},
			{
				"command": "GeoJsonViewer.askQuestion",
				"title": "Ask Question"
			}
		],
		"menus": {
			"explorer/context": [
				{
				"command": "GeoJsonViewer.askQuestion",	
				"group": "group1"
				}
			]
  		}
	},
                                            
                                        

如上,在contributes添加一个新的对象"menu";"explorer/context"表示资源管理器上下文;

command是要调用的命令;group属性是分组,即我们右键资源管理器后,分割线即代表不同组

运行F5测试一下;

扩展开发宿主窗口打开后,直接右击左侧的资源管理树,右键文件夹或者文件都可以;如图可以看到我们的扩展命令;

/net/upload/image/20220408/d4fb833634414debbfc447f7b2da0092.png

点击Ask Question;

/net/upload/image/20220408/320b6a2031aa491c9dbcdf56c8bd21a0.png

1.2 编辑器上下文菜单 - editor/context

打开extension.ts,在activate函数中添加如下命令:

                                            
let disposable = vscode.commands.registerCommand('GeoJsonViewer.helloWorld', () => {
		let msg="Hello VS Code"
		vscode.window.showInformationMessage(msg);
	});
	context.subscriptions.push(disposable);
                                            
                                        

打开package.json ;增加编辑器右键菜单 helloWorld命令

                                            
"menus": {
			"editor/context": [
				{
					"command": "GeoJsonViewer.helloWorld", 
					"group": "group1" 
				}
			],
 
			"explorer/context": [
				{
				"command": "GeoJsonViewer.askQuestion",	
				"group": "group1"
				}
			]
  		}
                                            
                                        

F5测试一下;随便打开一个文件,然后在文件中右键;可以看到出现了我们添加的命令,点击Hello World;

/net/upload/image/20220408/8ecb5dfbaecd419c95683a7d0255c72d.png

测试结果

/net/upload/image/20220408/f156a4ffc9e14f98b04f1183cabd843e.png

2 when 参数配置

上面介绍只要右键就显示我们扩展命令的入口;通过设置when属性,可以设置对那些文件或者在满足条件下才显示扩展命令

2.1 过滤文件类型(resourceLangId == javascript)

                                            
"editor/context": [
	{
		"when": "resourceLangId == javascript", 
		"command": "GeoJsonViewer.helloWorld", 
		"group": "group1" 
	}
],
                                            
                                        

只有打开js文件,右键编辑器内部才会出现helloworld命令;其他文件右键则不会出现该命令;

/net/upload/image/20220408/2108ed6bf3a8487cb81826e40d3c42d7.png

2.2 选中文本(editorHasSelection)

有选中文本,并且是js文件再显示命令

/net/upload/image/20220408/cd3e4ca14887448a8358281ea49f7653.png

至于when命令有很多,就不做一一介绍;大概有以下几种;可以去 官网查看

/net/upload/image/20220408/464773ef4ec04035bc899da778aa5b2e.png

QQ:3410192267 | 技术支持 微信:popstarqqsmall

Copyright ©2017 xiaobaigis.com . 版权所有 鲁ICP备17027716号