从0到1打造一款vscode插件——code snippets
前言
环境准备
-
node -
npm -
yeoman sudo npm i yo -g -
generator-code sudo npm i gernerator-code -g
开发者账号申请
点击 Visual Studio Team Services，点击最上方立即注册，注册自己的账号，可以用GitHub账号直接登录。
-
注册并登录 Azure DevOps。 -
选择或者创建一个组织(new organization)。 -
在该组织下创建一个项目（new project)。 -
以上三步都是为了获取开发者（publisher）的token，获取token如下图： -
点击 New Token，注意这里创建token一定要下拉选择all accessible organizations，然后点击右下角的Show all scopes找到Marketplace选择Manage。 -
注册vscode插件开发者（publisher）：点击此处。注册保证name和id一致，并且只需要填写这两个就可以了。
项目搭建
项目初始化
-
终端输入 yo code。 -
选项如下设置： language选择javascript，名称就是你扩展的名称。
项目改造
将项目文件夹yc-charts-code-snippets（你的扩展名字的文件夹）拖到vscode中打开。做以下改造：
-
将package.json改造成以下模样：
{
"name": "yc-charts-code-snippets",
"displayName": "yc-charts-code-snippets",
"description": "",
"version": "0.0.1",
// 开发者名称，很重要！！！
"publisher": "yuanchen-ljx",
"engines": {
"vscode": "^1.56.0"
},
"categories": [
"Snippets"
],
"contributes": {
"snippets": [
// 在.js、.jsx、.ts、.tsx文件中智能提示code snippets
{
"language": "javascript",
"path": "./snippets/snippets.code-snippets"
},
{
"language": "javascriptreact",
"path": "./snippets/snippets.code-snippets"
},
{
"language": "typescript",
"path": "./snippets/snippets.code-snippets"
},
{
"language": "typescriptreact",
"path": "./snippets/snippets.code-snippets"
}
]
},
// 仓库地址。很重要！！！
"repository": {
"type": "git",
"url": "https://github.com/ljx94nb/yc-charts-code-snippets.git"
},
// 扩展的介绍的md文档地址，也很重要！！！
"homepage": "https://github.com/ljx94nb/yc-charts-code-snippets/blob/master/README.md"
}
-
修改一下你项目目录中的README.md，无论怎么修改都可以！！！否则生成package包会失败。
编码
这里的编码其实并不是写js哈～，而是写json配置，在哪里写呢？在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入：
{
"FormTable": {
"prefix": "ycft",
"body": [
"import React from 'react';",
"import YcCharts from 'xxx';",
"",
"function App() {",
" const ${1:treeConfig} = {",
" // config",
" ${2:primaryColumn}: {},",
" ${3:columnWidth}: 120,",
" ${4:indicators}: [],",
" ${5:leftDimensions}: [],",
" ${6:topDimensions}: [],",
" ${7:topDimensionDataSource}: {},",
" ${8:leftDimensionDataSource}: {},",
" ${9:dataSource}: {},",
" ${10:operatorColumn}: {},",
" ${11:filters}: {},",
" ${12:actions}: [],",
" ${13:downloadCfg}: {},",
" // ${14:onSort}: (colIndex, sortOrder) => {},",
" // ${15:decorateValue}: (indicatorKey, value) => {}",
" };",
"",
" return <YcCharts.FormTable {...${16:treeConfig}} />;",
"}",
"",
"export default App;"
],
"description": "Code snippet for 'yc-charts FormTable'"
}
}
上面的代码片段是我自己封装的组件用法的示例代码。${1:treeConfig} 表示的是tab键会跳转的语句，数字代表跳转的顺序，注意：冒号后面没有空格。
调试
单纯的开发代码片段的话测试和调试都非常简单：
-
首先先自定义全局的code snippet。 -
选择新建全局代码片段文件。 -
创建完文件名后会得到如下示例代码，放开example下面的代码即可测试。 -
command + shift + D打开调试模式。 -
点击 Extension旁边的绿色三角形，打开扩展开发宿主。 -
在扩展开发宿主中创建适合的文件类型如：test.js。 -
测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。 生成的代码片段如下：
import React from 'react';
import YcCharts from 'xxx';
function App() {
const treeConfig = {
// config
primaryColumn: {},
columnWidth: 120,
indicators: [],
leftDimensions: [],
topDimensions: [],
topDimensionDataSource: {},
leftDimensionDataSource: {},
dataSource: {},
operatorColumn: {},
filters: {},
actions: [],
downloadCfg: {},
// onSort: (colIndex, sortOrder) => {},
// decorateValue: (indicatorKey, value) => {}
};
return <YcCharts.FormTable {...treeConfig} />;
}
export default App;
打包
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
发布
终端运行命令 vsce publish，命令运行完之后需要等待几分钟，之后你注册账号的邮箱会收到一封发布成功的邮件，那么恭喜你成功发布了一款vscode插件！点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图，如果是404请耐心等待几分钟哦～
结语
vscode的code snippets插件是最容易实现的一款插件，对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作，但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑，希望对码友们有帮助～。本文项目github仓库：https://github.com/ljx94nb/yc-charts-code-snippets。