一、前言
& r, ?& @( c$ R# ? 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。% W/ Z, A/ i F9 F6 { k' K
二、环境准备, h/ e u8 c5 R* i+ Z- x! R
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g: ]* R& R7 ^" }3 p: t5 h/ O% O
三、开发者账号申请0 e; ]. v9 E" ^9 o9 j2 a) ]2 L
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
8 Q( J4 N# w J3 ~$ w1.注册并登录 Azure DevOps。7 H. i: v% d" X0 T( `: S
2.选择或者创建一个组织(new organization)。
$ }; j0 r4 s: N3.在该组织下创建一个项目(new project)。7 o! o ^9 s# L- C1 V
以上三步都是为了获取开发者(publisher)的token,获取token如下图:: X$ i( X/ R1 q+ {& S2 G' k0 [- r
1 c+ Y+ U8 A3 Y& H
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。: B( h4 e' f D) _6 b( I& [( w
0 j1 Q% {% i* N+ w! D0 P5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。. o* H, b4 L- j1 ]) q n3 J
三、项目搭建
/ X/ p( j+ d/ k1、项目初始化% f) T) X3 r% k! l1 C
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
# e5 e. b: Y+ d
* q% M: I9 I" i' w3 T0 O
2、项目改造 M* E6 J3 W1 K* t4 v) X) t. V
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:) L7 R4 }, @! ?/ L4 T/ w" ?. E
1.将package.json改造成以下模样:; ]! K" W2 V$ B h; O
{
"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"
} 2.修改一下你项目目录中的README.md,无论怎么修改都可以!!!否则生成package包会失败。, ^8 \( a3 R6 F% [6 L% n
3、编码
' I" [8 |1 f1 I/ s 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:0 t0 V& ?' e1 ~9 |9 }
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
' ?; R+ s, e! m- P+ ^1 J四、调试
! g/ O$ T+ v( E. ]! y1 U6 E0 q 单纯的开发代码片段的话测试和调试都非常简单:
. V$ k/ O0 b+ Y }0 q- 首先先自定义全局的code snippet。2 M! q. k! m9 p
5 o j: O% M2 J$ [6 z2 V5 b7 S- 选择新建全局代码片段文件。
0 q, `$ j7 c! k% x/ {) q0 j
. M# x! e! f9 q% l- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。( d( S' `- i3 P( O- l
' ]+ g- }; S! w& I# c
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。; b6 I& l+ i! a; y8 g( u
7 v2 U, k6 S0 H- m+ v, w 生成的代码片段如下:* d7 a' C7 d% \) A+ h
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; 五、打包
0 x4 R7 f5 Q4 Z4 g5 a' { 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。$ _9 Y( I( } M: L T3 z% `' n7 u
六、发布
+ e1 Z. {4 N- r* v: I 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
3 w8 H3 @1 A2 R
7 p! B1 u+ D1 P 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
, R" E! t s8 {3 A
' u, ^; Z L1 b0 E. v) r: @* ?4 F七、结语6 B# y& |$ o% |& J/ S9 m3 W) W/ A1 r" H
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |