一、前言 * V" o+ Y: v: f9 a* c
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
4 p" p8 c5 a3 j- q; Q0 v 二、环境准备
4 _; e+ @ n" u/ V2 h( ? node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g- E; i3 D& R2 ^6 {7 {$ j: k* C
三、开发者账号申请
5 K/ f) ^3 B# I& s 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。. {* I& Z2 L) A& O n
1.注册并登录 Azure DevOps 。
2 y, U9 K" Z/ _: Y/ a2 C 2.选择或者创建一个组织(new organization)。
$ k! r* Z5 x) ~" @: q 3.在该组织下创建一个项目(new project)。
# U3 ?% N' ?/ n" D+ ?* M7 `+ t 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
/ y8 q% ^2 P+ @0 x7 |8 ?) ]4 X
0 o0 r3 a* A3 p" Q$ P+ U6 M. o
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
+ P3 b, a- ?+ D0 X; P: d$ j- g* b
+ h+ H2 [' q2 ]( s4 i( U 5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。8 [3 S4 u2 q1 p, `1 ~" C7 c b9 r( p
三、项目搭建 8 q' J, c2 A; h, u; \& P
1、项目初始化 4 a- A5 |/ ^1 H" ^5 E
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
% I' K$ w1 S4 b$ | y
( {) n4 s; r2 c: B; t 2、项目改造 . W3 k# Y! ^/ ^2 W7 I6 }1 u# \: s0 x1 K
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
+ i* [0 F. U, { v* _ 1.将package.json改造成以下模样:
3 e' W6 Z* l9 y# c5 i! H/ H2 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包会失败。* v- u- j: k8 ~9 h; L1 p
3、编码 - A" X0 j6 }* z
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
) H5 F1 _6 c) k6 I, _- R7 z% E0 M; M/ H {
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。4 I" h1 ], S6 C; ]3 }( l8 [
四、调试
, A9 q. `( w7 { 单纯的开发代码片段的话测试和调试都非常简单:5 f' s0 M2 N1 |9 x0 Y
首先先自定义全局的code snippet。
! e, O% }9 T2 Z1 |1 ^
1 R) _6 o& d* N% n; a
选择新建全局代码片段文件。
1 o/ u2 @2 z. N! a+ B8 c1 T
1 P, r* q2 k0 C9 G, P& T 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
8 N, l0 n$ h4 E
4 I! c9 ]# r; n* i# l
command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。/ b) U& x1 Q3 `! S1 ~5 f1 b
; M! a# z6 z& A2 I7 m8 r
生成的代码片段如下:
+ W S4 {9 I8 P$ s 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;五、打包 : O9 u: b. c, u. | _* p! I
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
% B* _" J, F% g: @3 K8 M* a 六、发布
' l& Y& l( |' u2 M+ B' \ 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!: `, P7 m: N+ c5 `' L3 x
: f/ n9 J* k# o 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
9 E( l! C7 ^) d0 @6 W- i6 u
3 t9 M) P2 X$ C2 p1 G- l* }5 Q
七、结语 $ C/ i6 r# V* @( X$ P" {7 w
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。