一、前言& |5 R8 y. ~, _+ |/ E. ?
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。, m' _: {/ ?0 C, h4 P; c
二、环境准备( [2 V. I+ ^& \0 A2 k) O1 O7 W/ A9 _
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g$ I) ]" s7 O2 v6 g% k
三、开发者账号申请1 F. t+ a% d9 I6 e6 h
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
; }& f) u8 }; ]1 y4 _1.注册并登录 Azure DevOps。
3 }+ |8 d% F! |1 T2.选择或者创建一个组织(new organization)。
* t F5 S0 Y Z1 n X) I* o3.在该组织下创建一个项目(new project)。
" k% R* L5 B; d0 U) E: n0 Y5 R 以上三步都是为了获取开发者(publisher)的token,获取token如下图:5 ~1 M& @- N. Q7 o; k' L, I
9 D8 ~8 |0 K+ N4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
. g: [8 w, y$ z! `; Q4 H! G1 h1 E
& }& U4 ], U/ V0 W9 _' B5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。) J" M7 ], t; e- _2 P
三、项目搭建* O, l: g. C2 d- O# ?
1、项目初始化. y3 Y1 ?, V) N$ Z: V c: C
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
* t+ O$ w. [9 {
* ^4 T1 j8 E( k( e7 I2、项目改造
2 c1 u( O8 D* m( Y6 L" ^ 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
% k: ]) i3 x/ T3 [1.将package.json改造成以下模样:2 c- W6 \' {/ g. A7 s) s
{
"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包会失败。
( ]9 a& ]* @& d$ }: Y3 B, X3、编码& Y5 p/ g& F+ @; s
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
. k/ J+ H2 Y* a: h5 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
3 Y v6 O; Z" }/ m四、调试
8 D0 ~& y* f% F2 ]0 ~( ?: p* Q- O3 b 单纯的开发代码片段的话测试和调试都非常简单:+ U( }: \" I/ e* k/ N
- 首先先自定义全局的code snippet。: r% v; [) ^5 R r& k& h% W1 M+ J4 v
6 V+ u" @+ f2 I& g3 |
- 选择新建全局代码片段文件。
( L7 {# x8 x& k
. O2 y7 [: s# o& ^; r, L0 a- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。/ a0 j9 h& _9 u
7 e5 }+ ^3 `. s4 c- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。2 F5 M* `2 i L% D' c) F4 h2 ]* M3 p
7 I0 i3 d# m+ K' F# G% I7 O; @" @ 生成的代码片段如下:
; r' e u8 j0 d- K; ]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; 五、打包7 l+ p) D% ?6 K' n3 w w6 s& I
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
# ?2 { B; V% P5 _六、发布
" W1 n$ W3 z6 `# e 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
* o- N! g1 A! b2 w9 g# H* c
! j( `' k! p6 T. s1 l$ R' j4 | 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
$ Z. F$ D* r6 f) f# l8 U: a6 s+ E& t7 w
6 o0 n# i5 k" u: x
七、结语
7 g C% B) ^+ Z0 B vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |