一、前言
% r7 M2 r2 ^' g* j1 Z 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
' |: w1 T' c7 T1 \) v 二、环境准备 . I0 F/ Q2 N. m0 z
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
/ P- b* A8 r3 }* Y+ O0 f, l 三、开发者账号申请 0 ?" _& N* X- o& Z" Q* [5 x! l$ f
点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
* x& n& C! C! l7 k* i8 z 1.注册并登录 Azure DevOps 。1 \4 H$ b7 n% d
2.选择或者创建一个组织(new organization)。
+ ?6 _6 e9 }; X# d 3.在该组织下创建一个项目(new project)。% o8 b6 v* m. _5 t. p
以上三步都是为了获取开发者(publisher)的token,获取token如下图:" o- `' L2 U4 e+ {' p2 {
9 z; X- U0 F n- ?+ J: o! ] 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
) m1 B- d- G) q1 I7 j7 H
( I5 ^$ u5 ?* O 5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
& e5 C( q$ j" N [& R 三、项目搭建 % b6 q- Q. q8 @4 F
1、项目初始化
]# d& r" n& D 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
3 q. ~" `- f3 M2 Z* U o
9 u' G8 M4 u7 V$ Q3 t4 W9 W) m0 W
2、项目改造 ; w% Y6 U: W/ `2 z
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
% o3 s: s/ n9 o: T8 ~ a( ]- \ 1.将package.json改造成以下模样:
G5 a3 M/ E9 q- C3 N e$ [ {
"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包会失败。
# r2 C4 R2 S0 d: Y, f0 V# r 3、编码 * p K" t$ s0 W7 u
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
; a, F) d$ D1 m5 J {
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。; o- D! q8 u5 e0 o6 g4 C. W5 Z
四、调试 m( O4 a' T/ o, y" L
单纯的开发代码片段的话测试和调试都非常简单:% z K4 b! E$ |0 l8 s: c9 C
首先先自定义全局的code snippet。9 K0 c4 ^) N" f9 f j5 d
, R" K7 y5 J1 M 选择新建全局代码片段文件。6 t0 @' g* X5 e. @& @
% g% ~ r# M, ] r4 P
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
5 G% Q- M' R% T6 h+ Z! H! q
& b3 d) f1 X/ l i, [% B
command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
8 t6 E, F+ o O2 L& j
& Z9 `% H7 y2 L* [. u 生成的代码片段如下:
, }) A/ ?+ @* |( U 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;五、打包
3 s- {1 u% s6 |1 z' Q" z, k7 M, q 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: |) s; m, x& Z) Z/ q/ Z
六、发布
( n" X7 h C2 \5 W- n/ ?0 o+ a1 E 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!- Z5 z. W l# b0 l
]) J6 }) ^ x" D7 \- | 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~9 ?/ S; a- ?' |
" H9 O: `: b0 o. z8 ?- r 七、结语 3 S9 R1 s- [$ X1 U5 B4 n
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。