一、前言0 |. c& S( A/ u$ D, r$ | K# o
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
. |& R; j6 [: X+ K二、环境准备# M- ]' P9 `6 T- K9 W. \
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g9 {+ t0 m; c2 G
三、开发者账号申请
W2 A2 r/ i5 o! k, N 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。/ B5 t2 d6 j5 ~# p+ ^* K
1.注册并登录 Azure DevOps。
) K% p* q% i b |5 N# B& A2.选择或者创建一个组织(new organization)。
* {; o% o3 l% l; }6 {9 s: b2 c, q3.在该组织下创建一个项目(new project)。
' {" E- X& E. ?0 E$ G5 q. M* [( O 以上三步都是为了获取开发者(publisher)的token,获取token如下图:" s$ w P8 A( H$ p5 o
7 y$ R1 }- B7 _! x4 d; S4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
8 z* N; @; m J& S F8 v
- a- f) o7 M: j z& `- k- J
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。 B9 x% r$ m/ m) ~ l% _2 \! `
三、项目搭建3 x- j+ x* T: H1 U/ Y, t
1、项目初始化+ a' a$ u5 _* Q X
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。$ V5 F' V/ O7 \9 n
6 _/ q7 m7 W, W0 m n
2、项目改造
0 q. T/ Y8 g% Z 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:; y' S9 J6 `% ~% M& i$ V5 ]" b
1.将package.json改造成以下模样:
$ [4 |; {. w& @4 V$ F' 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包会失败。
1 u& f3 `# G) C. {' b* U( K3、编码+ C& K+ H* C) x, I8 d
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
: q3 x* I/ h M3 d; ~# a% m1 s{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。* Q9 @! l5 \ ~5 j1 m
四、调试
( `! f. i- u1 w1 F# z5 u8 v 单纯的开发代码片段的话测试和调试都非常简单:' E- w: I" V2 ^: G
- 首先先自定义全局的code snippet。( M" g; t5 M; W" W
: J% ]; y! E& ]. ~0 o
- 选择新建全局代码片段文件。
5 d. c% a" G: j. O
, d7 [( l; v; j! f- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。. k/ c8 Q* B. b2 v0 P+ x3 e7 d
/ U) L1 T9 K; ^6 F3 c/ e: b) S% [- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
! z% x, t- Y- o3 k0 k& B
# c+ D2 N; R+ h1 G# c
生成的代码片段如下:2 [( k8 V$ W' w7 f7 z
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; 五、打包( B$ J- E2 g6 ]* o
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
& H5 F7 H4 S, n9 A6 U六、发布
1 X3 N) ~5 N: ^7 M4 f+ L" ~/ w 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
0 I( c! d( b# o9 w5 |& k
$ l! Z0 B+ Y1 K" I1 C; \) G 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
# g0 B g- I& F5 O* @5 e
) p: O3 D1 [. |( }七、结语" ?1 r7 ? b( s- t- P6 M2 f, N+ p3 Q
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |