一、前言
! _& Y- Y2 J" A; g, |1 i 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
9 V0 A4 T7 V' { @二、环境准备9 ?; E7 ^( A' |) j3 u$ h+ s( t
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g- A3 p4 `/ M+ S( e" d, `9 h
三、开发者账号申请! w2 X: ^, n6 e
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。2 N6 [+ [% R* W7 W: E4 f( h; w+ R
1.注册并登录 Azure DevOps。2 r7 m5 P' z6 D; l/ b
2.选择或者创建一个组织(new organization)。% q' R% Y, u, x4 C7 k \% I
3.在该组织下创建一个项目(new project)。
* N4 q$ k/ T$ Z( S' V 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
3 c" m3 \! o$ E' ?. V8 R% z
U5 d L, [% s1 O8 `! q8 `
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
/ N T. }& s& m. G/ l/ I" Q
' l. c9 O4 ` z& u8 B6 s
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
/ o/ D* p9 R$ S三、项目搭建8 n4 t; }8 z. a5 d" p$ p1 x. |) Z
1、项目初始化
D; Z! N5 N9 C$ I2 m% f! a- ^ ]- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。3 l6 x1 n/ X" \5 J$ O. b
% W; _( E7 b6 h1 O' J6 k
2、项目改造 G0 e" Y- Y3 `; U6 r/ p
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
& K. s4 K9 v) ]: a" d1.将package.json改造成以下模样:
! D; a, \& `/ f: g{
"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包会失败。' Z0 u4 K: E: \' ^
3、编码: e% r# A* _. u6 X# q" w. D! E
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:: ?9 D9 y% ^7 U8 F% e
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
- ^( t* Z. r- A四、调试
+ N/ n5 E$ A9 t. w" {7 c9 j. | 单纯的开发代码片段的话测试和调试都非常简单:* N) o& ^+ m( H& \ p" ] y5 Q- u
- 首先先自定义全局的code snippet。
# ~) m( c: Y1 c2 U$ }
7 v# Z( y, e1 G# k: j5 W& X k; [
- 选择新建全局代码片段文件。
0 I; l' p3 i+ K3 F+ z5 d
' z4 a6 ? E0 B" S( T+ {- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
' m" w5 P1 K7 a
* J/ _% E, N+ k" T' a! p ?- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。; R2 `. a* k8 R) @) b& S" [
" A4 X6 k# t5 K j, h( I
生成的代码片段如下: n8 I5 i8 K E7 k1 j; P
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; 五、打包2 N0 v* W" ]! M# c6 F1 f
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
3 L6 Q8 P B3 w; x; q3 X0 R六、发布
2 u9 W/ @5 x& l 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
0 Q+ ^' {: k2 b1 S8 q) M3 }- ?7 _
9 X/ i, l7 e, n3 t2 d! c4 y& R. W
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
8 W: J8 x2 B" _, {# L, c
7 T2 N; D! p0 |* ~# I) o
七、结语; m& A% C% ~/ d S5 [1 {* a' C
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |