一、前言; u% q' j8 h' F! @4 w! p
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
& P# X% m6 j, r) ]2 V8 l m二、环境准备$ g( Q$ x' c, O0 f) U) C
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
9 z# r+ L8 e& i$ F& }; v% W$ M6 D 三、开发者账号申请; v! f) w! |5 q8 ]- Q+ I2 P3 }
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。: E% z9 u/ I" l' B9 i- {
1.注册并登录 Azure DevOps。+ l& {" |1 s2 M. l
2.选择或者创建一个组织(new organization)。/ d( }! y5 k/ D; k/ b
3.在该组织下创建一个项目(new project)。0 W( O: j6 S4 r
以上三步都是为了获取开发者(publisher)的token,获取token如下图:+ h6 M* q2 m9 k. g Z' V2 G
2 k% p7 p5 S/ P% |% f5 g
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
% @$ |6 o6 g# F7 H4 i; Z
5 M! D7 U3 g% \; w
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。9 T: m# c7 x* g l
三、项目搭建6 ~7 r) V5 I) O3 t" f% s
1、项目初始化' D9 ^+ |5 ~0 n, W1 C5 O* D+ c( L
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。! d1 z& m5 ~* A$ A9 N3 y9 f
; H7 U* S' y" a. z; w) l; y8 W2、项目改造# D* s& W/ t1 ]/ l I
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
: G; z5 R3 t* i6 j0 R% _# T1.将package.json改造成以下模样:" Q j- n* U s N2 }: S7 q
{
"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包会失败。4 g+ E2 Z* u; Z% M8 ~
3、编码: P. q1 `2 {' w3 A
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
! j8 `" S, e9 F* h7 K8 f{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。7 }2 H+ [0 `! ?" ]( I+ l1 r# H3 r
四、调试2 m3 l6 |7 F; |' X1 n# B+ G# e2 z# `
单纯的开发代码片段的话测试和调试都非常简单:
* s" S9 }4 R) D- 首先先自定义全局的code snippet。+ p7 A2 N5 m6 B. w5 U
1 u9 I' b' \+ y% q/ _, Q
- 选择新建全局代码片段文件。% S0 ^! Q& ]1 R) @ @+ j
* X4 ~( N% h0 g$ e
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。9 |# J- [1 M; L0 |
- v& X; K6 w* e- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。! a! o0 V6 I( y
7 J- H! b5 f3 d7 Y* K/ M# J7 q 生成的代码片段如下:+ U" P1 C% B$ y% p7 Q: Q
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; 五、打包
6 J$ F. W5 _$ p0 u6 u* G% Y! i 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。7 t. |! S. ]6 V; U) W; }) q
六、发布+ H$ n+ S' l3 _, R2 R
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
+ K9 }: |$ A" S% D [: F& W
3 s' T9 |4 z; i
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
U9 i, }' U. \( ~
% } T( ]8 `( T七、结语
9 u' C1 N ~9 r# l5 L; \ vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |