一、前言 " U: I1 I; H$ h
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
( n# a& t* t; d 二、环境准备 8 b8 `9 S- E, P6 y8 R3 E+ D
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g' I' u1 z$ h! Z+ U$ m
三、开发者账号申请 8 d8 d u$ f/ n9 i5 h
点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。3 O0 R j3 [* I" q: l
1.注册并登录 Azure DevOps 。% p. W& |* ]4 s I5 q% u1 o
2.选择或者创建一个组织(new organization)。
* U, l f9 z% v5 z 3.在该组织下创建一个项目(new project)。
; h8 G X' N! h! z! J8 j 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
) `7 O6 g2 c# U8 k- X
9 P" T; R( k8 @2 B0 ]. X# M, d 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。' W* N9 V0 P' ^
3 z* y, }8 c/ F6 K0 ?
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
" V- j9 Y9 {& A$ E# a8 M 三、项目搭建
% t1 @. [2 D- f2 Y 1、项目初始化
' v# J# B0 g0 f) p# _% \1 e( u 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。% q: c% g) ?* H/ W# w8 M
& Q" P% I7 x4 v1 v' S! h 2、项目改造 * h# R) I1 B8 v k
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:2 @2 g3 ~2 h+ n/ {
1.将package.json改造成以下模样:9 @ j2 z' b2 w' T$ U( m3 J8 \
{
"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 I. ^: Y r: a( k. w+ s4 A J 3、编码 2 l/ s: e2 l9 z8 s7 \. I
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:. A9 D, R. L% N: S+ y
{
"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 O5 W$ H2 _7 c f' L 四、调试 ; i6 Y+ u2 o1 K( g9 ] c1 r5 d
单纯的开发代码片段的话测试和调试都非常简单:* a* C9 H3 J- g- }8 R; y4 K) n
首先先自定义全局的code snippet。+ ^8 l9 z1 y5 B/ ~
S' A6 ]6 }& B. z- A% J" J1 o$ z
选择新建全局代码片段文件。
$ L( E4 m0 n5 [+ J
* l/ ` w: _& G1 `3 y& F' t% G$ p
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
: S; i+ M$ E# e( X) z' l. f8 T
4 T; Y% g0 t! h) O: P command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。2 l5 M1 n, t# z- @; k
7 O n" K% f5 c9 a+ _$ G5 | 生成的代码片段如下:) p. e* u6 _( ?1 i7 A2 I
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;五、打包
. R$ Y \, N$ c, f6 ?3 O( V 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。0 u0 s+ O3 s$ o i
六、发布
7 x& l" o7 t7 a0 \ 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!6 [8 y$ w7 R: w* p+ u/ w
; s5 S! i7 F5 B( C/ U0 Z" @- O6 d
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~1 a& \# w; k, g
% ?1 G) _( r$ e" c0 m 七、结语 ( F; q" _ j0 s7 @ B) J
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。