一、前言& n6 Y" M( L7 t7 D1 k. Z
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。) n) e' y; {, I+ G9 s+ Z
二、环境准备
, o9 e& C5 B! J& m( h! R- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g7 o: T6 W- o2 ^# H4 E& r4 E
三、开发者账号申请
' L7 I& n% S! V( ?. t. z) Z 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。0 g7 H$ I ?. C3 p( N$ E! ~
1.注册并登录 Azure DevOps。
7 Q; s* ?1 T- j6 y* w2.选择或者创建一个组织(new organization)。
9 M1 `/ l" O( j" ?3.在该组织下创建一个项目(new project)。
& l$ P o( b7 J! E5 a 以上三步都是为了获取开发者(publisher)的token,获取token如下图:) ]" _# P+ i& h- B
L( F0 D6 W" L4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。9 ?3 z3 A( b9 h7 `1 o3 |' R5 U
( x& R- ~* \# x5 k) y4 e5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。) F$ {. K! @& t7 A, f# G: v
三、项目搭建
' ^ v9 b" I" ~+ E/ {* \7 l! e% L7 j# m1、项目初始化 J, o- e" V7 q2 Q' t- w0 M
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
3 _: d& H. \6 q8 W( o7 g# E- C* B
0 g3 A# O8 ~+ I: m
2、项目改造 i; Q0 I% G, ]
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:& P5 H, p, e3 v: w; z
1.将package.json改造成以下模样:
2 h/ K9 j) D, ?7 n# j- 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包会失败。
6 t" Q6 h7 ^' K3、编码" v, j1 X" w: E
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:/ K4 I+ n1 d# i7 P e9 E. u
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
9 c9 s5 T: Q G; W' A: C P四、调试
& e% ?; E7 n* u+ D 单纯的开发代码片段的话测试和调试都非常简单:& H1 C G& ~5 |* v% y
- 首先先自定义全局的code snippet。8 G1 _( H3 C5 N2 [
3 I+ i6 r6 k/ `. p9 n" b q
- 选择新建全局代码片段文件。0 e) D! ]' c5 Z: W/ J+ U
3 E# P8 O+ |' P. A- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
7 o: \5 s* S& Y# w4 g
3 D, ?* H) K. C" ^+ E3 F# L! H- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
) @8 t$ z6 b8 m- ~5 f$ s
. Z2 v7 h1 j+ W7 h' t9 W7 e 生成的代码片段如下:
4 y! t- ], I5 X7 j, eimport 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; 五、打包
7 z" D4 c8 A C( }* u) Z 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。, d* w% [: O. {& @
六、发布
) N: Z$ I, A' o; n2 ^8 G% k3 [ 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
# w" v* C+ m+ H* Q
' j* [4 m% H9 j( e' p 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~ |" A5 g( O/ ~3 a% r. B
6 P* D2 A/ y" Z9 h# e- m七、结语
4 A! ]1 J8 O8 ]8 a. m vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |