VSCode插件开发(四) —— 代码片段

系列文章目录

VSCode插件开发(一) —— 第一个插件
VSCode插件开发(二) —— 常用贡献点
VSCode插件开发(三) —— 调试及其他
VSCode插件开发(四) —— 代码片段

---

---

代码片段

创建代码片段

// package.json
"contributes": {
	"snippets": [
		{
			// 代码片段作用于那种语言
			"language": "javascript",
			// 片段文件路径
			"path": "./snippets/javascript.json"
		}
	]
}

设置

每一个插件可以创建一个属于自己的专属设置项，这个配置项会出现在系统设置的扩展下面

"contributes": {
	"configuration": {
		"type": "object",
		// 显示在配置页左侧
		"title": "Code插件demo",
		"properties": {
			// 全局唯一的配置ID
			"vscodePluginDemo.yourName": {
				"type": "string",
				"default": "guest",
				"description": "你的名字"
			},
			"vscodePluginDemo.showTip": {
				"type": "boolean",
				"default": true,
				"description": "启动时显示自定义欢迎页"
			}
		}
	}
}

// 读取配置
// 如果没有设置，返回undefined
const result = vscode.workspace.getConfiguration().get('vscodePluginDemo.yourName ');
// 修改配置
// 最后一个参数，为true时表示写入全局配置，为false或不传时则只写入工作区配置
vscode.workspace.getConfiguration().update('vscodePluginDemo.yourName', '前端艺术家', true);
// 监听配置变化
// 修改任何一个配置都会触发如下方法，没有专门监听某一个配置的写法
context.subscriptions.push(vscode.workspace.onDidChangeConfiguration(() => {
	console.log('配置发生变化！');
}));

自定义欢迎页

结合设置和webview的知识就可以制作一个非常简单的自定义欢迎页。

发布

主要有3种方法：

• 方法一：直接把文件夹发给别人，让别人找到vscode的插件存放目录并放进去，然后重启vscode，一般不推荐；
• 方法二：打包成vsix插件，然后发送给别人安装，如果你的插件涉及机密不方便发布到应用市场，可以尝试采用这种方式；
• 方法三：注册开发者账号，发布到官网应用市场，这个发布和npm一样是不需要审核的。

接下来，我们实现本地打包发布：

1. 安装vsce工具：npm i vsce -g
2. 打包成vsix文件：vsce package
3. 将打包好的vsix文件上传到插件市场
   

注意执行第2步之前，请确保package.json中正确配置了"publisher"和"repository"，README.md文档也需好好写一下，方便大家使用。