一、前言 9 I- d* A, j4 e* v
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。 H6 T( c/ [& `! w. ~5 [0 v
二、环境准备 " Y: t; E4 D* W/ l' H" Q7 G
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g9 F( l7 H6 m; P' U8 i* B
三、开发者账号申请 * w; _ G' a/ Y9 v, C% j
点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
' y2 [" d2 `1 T) z$ D 1.注册并登录 Azure DevOps 。- j0 L: {/ A5 O3 y) e, Z" m. p
2.选择或者创建一个组织(new organization)。" k r x/ c: U* ]; n! c, {% c
3.在该组织下创建一个项目(new project)。8 n; G# _ n0 J$ T a
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
* T- h! T5 I& |' Q: t
4 E* z7 G7 a" J3 w- c+ U l
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。/ D+ f. e+ P. i5 h6 v- b% ~
. o: j( d0 Q" C1 T8 g0 [
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。1 Q9 v5 W% z" ~+ P
三、项目搭建
# ]+ Z& ~6 y; f8 E- S* ^ 1、项目初始化
; P7 ~, r. A4 q2 k3 C m 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。, G0 c7 i8 u" y% Q
4 B9 ~- d) f7 k5 N' r5 y; \ 2、项目改造 1 f# ?; J. }* j3 z
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:5 l) O' p' e* \9 l* Y2 |/ Q8 V; a
1.将package.json改造成以下模样:
0 t8 G/ D+ e& d5 i: n: n4 D {
"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包会失败。
+ v8 m) B2 q: Y 3、编码
* t$ K, U0 G: K9 F+ @9 S8 s! B 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
4 F: l) P7 h, o/ 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。6 b. m! j% w6 e% o( Z% z
四、调试
7 w9 p2 P9 J5 A9 {3 w3 G; x7 @ 单纯的开发代码片段的话测试和调试都非常简单:
O$ ~. o1 p, X" P0 O7 U/ ^8 \ 首先先自定义全局的code snippet。2 Z0 g$ {, u, e
. k" ~; m: a+ j3 I) Y* Q9 ~ 选择新建全局代码片段文件。% w4 K; ~8 Z9 t, z
' p+ }" {1 ]2 S5 e( E& t' d; r) `6 n 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
2 ]5 H) h4 t: o x( W
, `( _: Q6 j1 M1 y. ~ command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
: K V# B6 O- `9 B0 A) K! E9 ], k
{' M2 y" i; i2 ` F( Z, F7 G4 x 生成的代码片段如下:
/ Q1 \+ i7 ?. r1 [ 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;五、打包
% D+ ?. t: e0 [8 J" N 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
6 V2 d7 ~3 F: n+ E5 L! ~ 六、发布 % U) {) i$ Q8 M1 s1 Z
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!+ G+ K5 Z% W5 I. G0 }5 P, {) A+ W
|6 Y# {# l0 I4 B i" j" K4 O) n 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
4 {# ?% T6 }0 w
4 P z8 Q: `8 X/ a/ ~5 w+ }
七、结语 8 p: [6 f. F5 g, F5 M1 [
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。