一、前言7 F; w, W3 C! {4 ^2 S! L
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
3 l: ]0 o, w& G' p二、环境准备
* p: a7 |; ~4 ~! Q8 V! l6 u8 H. ?- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
. ~- |! d- X, [6 m g4 R 三、开发者账号申请
$ n- Z* V" @' B) \. d% ^1 Y% l 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
2 Q1 Z; W6 R3 ?1.注册并登录 Azure DevOps。6 I" f5 p4 z+ N- A- `) S: L
2.选择或者创建一个组织(new organization)。5 c6 H# }: W; Z1 ?4 p
3.在该组织下创建一个项目(new project)。* V' |/ T, [6 d- _& o: ?; q
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
$ U2 ?1 o) s( i7 R, J7 E
! P% z) {5 y8 h3 p! b+ I2 m4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
& K" J5 U. x" H! q9 h9 B/ b7 L
; I9 [. z a% Q, W; w( p
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
+ D( w& _. K: q5 F/ R3 w) D三、项目搭建+ Z8 t* D. I" b2 x4 M
1、项目初始化0 t, e( A% J( U" t
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。3 n( W3 }8 t% |# a7 W/ @9 c8 R! ]
8 f& m0 z7 q4 z6 E$ B2、项目改造' A2 I' h5 g, e% y6 p4 ~7 ~, D
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
/ N% w) S; A& B( |7 Y3 |) R5 C3 |5 C1.将package.json改造成以下模样:& A3 x8 }* w# o, Y* d5 S! J
{
"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包会失败。& W8 O; f( o& s/ Z* J7 o$ L
3、编码! h, N3 }, p: b, x/ R. U' y5 Y3 S
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:, o- d, R1 k; R* d
{
"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 A4 B) H% E1 k3 x4 G四、调试
! k0 K- X$ s& `7 r( p* O) Z 单纯的开发代码片段的话测试和调试都非常简单:/ h; r' k5 E5 w0 k+ h, z1 p" q; L6 h
- 首先先自定义全局的code snippet。
( b, Y e; R! `3 v0 `* |9 B
" C5 [, ]# n$ t- 选择新建全局代码片段文件。 ]0 x0 \0 ~4 w6 K' ~' T" V& N
/ D6 o2 m1 q) ~8 V9 M- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。- ^/ Y5 C9 w' L) u9 G9 l
2 x4 J" ~5 [# i$ N- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。+ ~8 k4 ?1 r' \4 K0 g5 j
0 A3 B- N- c" [' u5 r/ X1 L
生成的代码片段如下:) r7 ~( F3 X( U2 }3 n
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; 五、打包# w% Z. ^ b% H; L
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。* u- X( {4 f( o9 G+ ^/ W2 |
六、发布2 x, I+ {: x( H; y3 v
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
2 m& ^" d* S! L, O& u R1 v
) D c3 b: ]& ?$ s& B; R
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~0 X) z, {& H3 m! r0 F: y4 Z
# j8 `# C' Y `- R- C七、结语9 [+ V* _) }# Y6 x
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |