一、前言7 p- ?# u1 X2 r! I
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
. u* W/ [- F' F8 H, Z9 g3 J二、环境准备6 M+ r& I" A0 p0 y( C9 H' n+ o, O/ x
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
, Q. {& w b/ O 三、开发者账号申请
5 M. k! P m$ z5 L 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。# x9 I8 a& O- M: B, g! n
1.注册并登录 Azure DevOps。/ G2 k1 A8 U5 S- r$ p: P
2.选择或者创建一个组织(new organization)。
( K' A }" D: Q0 _3.在该组织下创建一个项目(new project)。
" f& m" n) F- c; h% e 以上三步都是为了获取开发者(publisher)的token,获取token如下图:* ?$ _9 N( V: D* Z' o
1 \0 e A3 }: Q5 O4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。4 I4 V; Y- R0 M
5 G& n5 S9 Q3 G
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
) U6 m; q9 J1 x" B( \7 |三、项目搭建1 X6 U& J6 }5 Z$ R
1、项目初始化/ K4 Y, D6 M9 O3 j+ _
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。* Q2 g; V, g, B4 e
7 ^4 [" A; B: h; p# ^2、项目改造
- r& K; I/ s! e% f 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
5 a& n6 j; A* r( }, N1.将package.json改造成以下模样:
; P: @& v, z3 j+ G8 @0 R4 S# B$ t{
"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 f! g ^9 i4 D1 Y. B3 Z, E
3、编码
$ E, i! ]1 }2 N- J7 _: S0 I1 V( p 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:( {7 l' R' E: b9 S, Y4 S: }
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
% [) ? P+ U6 \: G K- ^" ]四、调试( H5 q9 m2 p" E: f2 g
单纯的开发代码片段的话测试和调试都非常简单:
$ u' |0 O. N# O, q. P5 i& U- 首先先自定义全局的code snippet。3 w8 m* { `' W: t4 H; z8 G, O
9 u& n+ Q1 o6 c- 选择新建全局代码片段文件。
% m' r0 C+ h7 [9 h
% M: P5 Y/ ]% I0 }" P3 I
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
5 Q) n" ^6 ?4 b9 t ^
8 M6 T- l* A4 W
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。* S: C" Y, N5 D. |, t6 e
2 l# j+ c1 v, j6 v 生成的代码片段如下:' m" X' j; o. }0 H: m3 u* s
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; 五、打包
6 Z, B3 e# k0 z 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。1 f- n/ N8 K4 @: h
六、发布9 w' N8 m. z3 F3 K8 ?1 Q5 R
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
! z1 `: T' d% W0 i& h1 P
9 A: Z/ K/ H6 G7 L/ r 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~- |$ K, G8 T* ~, L/ L6 V( ^0 ]
, l+ L: y; p0 E g* W! Y3 M七、结语
( V2 w) E+ \+ k/ G vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |