一、前言2 r: f- p% X/ A% J. i) @8 f$ l6 E0 `
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。8 l i4 k! n$ @0 Y6 P4 p
二、环境准备
1 S8 B+ P6 [, E( ]5 }* q$ g+ d- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g$ S) {- V3 K$ K; V9 F4 D+ s1 F
三、开发者账号申请
0 T9 S. R9 g) R- } 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。) N* F& o1 R: K1 T. d5 |( O- Z
1.注册并登录 Azure DevOps。9 Y8 J) |8 [0 u2 T, x+ f* ]4 \9 a
2.选择或者创建一个组织(new organization)。# C1 f3 g- z) A: i
3.在该组织下创建一个项目(new project)。
& {9 R, [& H: h A3 Q 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
, F5 _; N0 j7 ?- N, y7 D0 t
1 L) E) O8 u% N' T9 M8 `
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
5 e% O! ~. @2 }
/ l9 Q& i0 K( I" W0 e
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。5 Z: t; s! O7 r; ^. B
三、项目搭建4 p0 |/ c( k; t! I$ y
1、项目初始化! f' {" f; O8 D# l
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
$ l: [1 I# i m. J. Y. ?1 N
8 W) j, m0 D5 f" |1 s, u2 Y
2、项目改造
6 {, z- |" @! `1 d1 J+ O) M& r7 q; b2 w 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
# Y, Q2 a) \4 W9 c' |. U+ g1.将package.json改造成以下模样:. ]$ n. }0 ~0 r+ l5 v8 z
{
"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 }0 [' }* ~9 F l7 w1 ?1 M* M
3、编码
i: i3 t2 [. e, w: G. T2 o5 x& q 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:4 Q, T+ F, \; h( C, R
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
; M" f/ {! ]% ?& P3 [四、调试/ q; ^# Q t# R- _/ W
单纯的开发代码片段的话测试和调试都非常简单:* F& ~! Q% n# X8 T- ~+ F2 i
- 首先先自定义全局的code snippet。) i" Q6 J7 }" y9 N, d1 W
4 p! P8 C' g2 t$ c+ l) B- t5 W- 选择新建全局代码片段文件。
+ X4 `9 ^) m2 n; T8 `
5 j7 g2 t: }6 z! P4 V% q+ S4 L- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。. h1 F3 U. o- ~+ B8 g- s
- S; k B8 t0 ~
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。; e" m6 L) m6 u; @0 @
6 _) d/ m( O; C0 k
生成的代码片段如下:- N R2 g# B( z, x( P
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; 五、打包
9 Y. `$ d7 s& o- W 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
" I$ h/ C; b- K- A六、发布% O2 h$ p# c% N" ?
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
" |3 w3 ^4 c& N; O K
3 ^: A5 p5 _8 _) e7 i- Z- x* L$ t 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
1 ^$ X; k9 Y3 [ e M
+ K0 R) \) @; Z七、结语" q, I1 V4 Y; e: P7 S- k
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |