一、前言 ) f, O9 u* E+ G4 T
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。0 G/ d& A4 l+ ]/ j( }
二、环境准备
# Z( b2 j) _8 u. N3 U0 Y node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
4 O/ `: H4 J" G L 三、开发者账号申请 , T( i! u5 J. D1 {1 |
点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。; t( @9 s7 A0 U8 c' ?, f9 }
1.注册并登录 Azure DevOps 。
! D- t" ~ P* a7 S 2.选择或者创建一个组织(new organization)。9 c. }7 L4 [: ?6 |6 {/ `
3.在该组织下创建一个项目(new project)。
$ ?( I% o: D4 H, [/ Z8 E9 x 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
& O" Z" @6 Y: p1 ~% N1 o d
1 g9 s' A# H& P7 `5 U 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
" ]9 L" ~* j8 y2 r+ r# z: b
7 _# T$ O# ]( x8 v6 |* @ Q# Y
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
9 U0 C/ D# P: f% B2 {2 O 三、项目搭建
2 ?: V y4 d( _0 h4 X$ b 1、项目初始化 # v% f8 e' C' u! J& T
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
1 S9 T1 d2 O+ }" H3 V+ }
8 N$ B$ t4 x, E' ^# m; n( c
2、项目改造 ! p" ~* r( \2 R: |, o
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:( L. N% j B4 `: g- D5 y
1.将package.json改造成以下模样:$ x& g* p2 l) R' f9 J6 w
{
"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包会失败。0 l* y, T. r; l' e$ i
3、编码
$ k) b3 q0 q& h1 k0 w# P+ c2 h 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
6 T! A8 Z; F) Z' g% B. w* e {
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
1 C# ~! d* A; ~2 Q* i% T 四、调试 ) ]' P% u a9 `
单纯的开发代码片段的话测试和调试都非常简单:
/ T/ f, ~8 {1 R0 D 首先先自定义全局的code snippet。
$ N, [# z1 p. B5 Q+ }
5 D. ]0 Y3 `) x 选择新建全局代码片段文件。
! l+ l" | s1 d/ H" B( |& D
& T: B. O0 v1 a 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。1 Z9 o3 l, \5 Q8 q7 j7 s/ r
: \$ T L% d$ P, Q' V! a command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
% q* Q0 `, ^6 H$ S4 V
3 t/ i3 @3 o' O) H8 ^+ p' s 生成的代码片段如下:% q, Q4 c% P; D8 b2 U! a3 o
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- r% e: S* r
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。, J! ^1 s7 w0 v X
六、发布
) V' u. j4 Q2 d0 P& s# Y 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!8 K; h1 g: }$ M2 |2 ]8 C9 {+ c: ?* V0 C! a
9 s& E- j1 T6 B% e9 B% R) [0 _
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~* ?6 U" V/ v8 m- u% ~- W
s8 J) Y7 m% S! J! G: }' K
七、结语 : L! q6 L9 h/ c$ E R. J( Z' O f
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。