一、前言9 j1 C0 o* r& \/ ]6 f" Y
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
5 b# i' O7 s; @二、环境准备
1 i+ ]+ q x. ^: E- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g( b) m5 J w. B, f) `/ S
三、开发者账号申请; o! T5 q; D) }) g2 B
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
! B6 f& C! R9 y1.注册并登录 Azure DevOps。
6 a, j* h% a1 Y( e9 u' K2.选择或者创建一个组织(new organization)。
. F( Y7 ^* q( ^* F- d5 s3.在该组织下创建一个项目(new project)。 Z4 |( e" S2 q$ l4 i6 a
以上三步都是为了获取开发者(publisher)的token,获取token如下图:9 _5 z& i+ R X; N# m
$ T- N1 O& |5 M8 `" D; U0 D: {4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
0 q v) C4 b" I4 R
% U; r% l( b" |4 [5 U' P- x' n) k' w
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
, f* e& _% O) F: L+ W三、项目搭建$ e( c) w* |" K$ E
1、项目初始化& E5 E$ b, X6 v) F
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
3 c3 f6 Z8 F& m6 D0 \% T
6 `6 b# w, W4 T$ k& l2 P) v. i
2、项目改造; k" _8 {: l) Q4 j1 e7 l
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:/ E) H- w. p4 S$ p* J
1.将package.json改造成以下模样:
+ G6 N) O4 G( Q* q' v{
"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包会失败。
- e* y' a& G7 M3、编码/ p/ }( e( R6 \2 _' w& K
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
( \! P* d8 ~3 \' r* c% Y9 b{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。 G* H# ~+ W6 @# O0 l$ p
四、调试
$ ?8 X1 g1 G) h A8 }, o 单纯的开发代码片段的话测试和调试都非常简单:
) o8 P8 ?' S, z4 I' [& ^- 首先先自定义全局的code snippet。9 E2 F- ~- J6 g6 {/ @8 R+ Q
4 p& d* ^" x" C) z8 Q, t6 d5 i
- 选择新建全局代码片段文件。
* S# z; h& j9 g; K% L) X: k0 ^; n3 p+ N
+ u/ Q/ a% b+ _- e) s- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
4 {& `1 Q7 X( |) S4 x N
- {0 Q6 Q6 m, v& X: h* J* z9 f- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
% P8 h7 P) T4 m ~5 {2 S6 j0 o: {
. Y! ?& |& T& J _+ ?4 `
生成的代码片段如下:
. I( g+ _2 e; Y4 N9 z+ [( `7 aimport 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 _9 O- J1 c, x8 n7 m4 e 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。- S" |1 |) u8 `
六、发布2 G( H/ {& Z% ]7 G2 v
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
X) j) g6 j0 [8 l9 T. @ |, t1 P
- }2 N2 A g2 n+ g9 o2 f
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~' v8 U( C0 c* G) v% V
# b- c& j" r5 H! i' U七、结语
6 {# y9 P/ o+ M# a ^ vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |