一、前言" i' b7 |: q8 F) x; K
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
6 U+ r, S3 e; w. h- s; \二、环境准备
) N# P2 s, y! ]: U7 T- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
; q. v- K. K+ M' N/ R& v 三、开发者账号申请. N# ?2 C6 O9 w0 W
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。9 R7 l$ l) M% `0 m
1.注册并登录 Azure DevOps。" m q) n# `4 x* J
2.选择或者创建一个组织(new organization)。( w- `: y0 m8 [( ^7 C
3.在该组织下创建一个项目(new project)。
' T) W, S, Q0 @, F5 p# @ 以上三步都是为了获取开发者(publisher)的token,获取token如下图:. p- p9 u, c% s2 t: p
" k4 K+ n8 C: ^7 Z2 z4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。! c3 F/ I+ y6 U3 L5 I# Y) M
, J: @3 d: L0 }5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。% E7 u9 ~7 } @3 I. O
三、项目搭建
( O9 L& Q% \& i# Q1、项目初始化
0 q, R2 ?) r+ ?) X# r @- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。# T5 c, e2 O" Y6 B/ v9 s
6 K/ f6 u; P* U4 I8 a4 B
2、项目改造* l7 d, X) o0 L0 h$ t& ~
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:7 U, y5 [% Z% G) M8 q' q5 W. L% i
1.将package.json改造成以下模样:
1 y0 \3 @ t5 w) P0 G& r{
"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包会失败。
" m9 X3 s c& _/ Y) T! T3、编码
0 @) R, t- j4 O! Y$ D 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
3 C! V2 T7 |. l{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。$ D1 d; |& {7 k. o
四、调试
5 {; ] n C6 e) i! U6 ` 单纯的开发代码片段的话测试和调试都非常简单:+ G, G" h, Y) ~4 r4 R
- 首先先自定义全局的code snippet。+ E. R; w3 C$ N
( M. ~8 t# z8 X- 选择新建全局代码片段文件。. Q/ M* v2 V$ p0 N( c' p
$ w2 A* Z3 h" D) f. j$ Y- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
$ H5 B( j9 v! G {* y+ m3 }
1 p: p9 W7 g# y5 l4 U$ R- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
+ K7 L# n& I+ W( M
4 v; h+ ?8 w2 k. E5 O+ R
生成的代码片段如下:
: ]# K7 }; i H' J; x/ L" r- Cimport 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; 五、打包
# c, Z# ~3 ?/ E. `( @* o3 U: B 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。# Q$ Q6 s+ z( P$ K) L! o+ D
六、发布% V+ G, ]7 ] N0 d0 J3 {
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
+ o* Z; w' x& b( t
: _) i7 ]2 t1 Y+ b% v
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
8 t7 j' }8 u, i6 Y: o
! Z( j' _- b: d七、结语. H* S7 w5 T6 b2 w# K' q
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |