一、前言
) l- r( O2 W- P" K- V 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
. p; K4 a% z c- H# {2 \二、环境准备0 |. w9 X3 [) o* v2 o
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
$ ]( V. N' ~* d+ O 三、开发者账号申请
8 a6 d3 @% q! a' R, R. d 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。0 ?4 V0 b f1 I2 K5 n
1.注册并登录 Azure DevOps。7 \$ a1 v1 Q6 a _1 z& H5 l
2.选择或者创建一个组织(new organization)。
- s+ \- Y" F) H5 }0 @3.在该组织下创建一个项目(new project)。
4 ?0 y! V) v/ S' N, x! n& }# i [7 x 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
( ~8 F9 h: s% r" h( k
) ~+ _1 t$ V2 `! }
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。4 ?7 K! ~& Q4 |1 y8 t. @3 O
8 [" H0 z, D. ]
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。; p m) N" S3 C z8 [. E# ?) q
三、项目搭建
1 S/ D- f6 ?9 E& j# B/ p* d1、项目初始化
7 c) n0 A2 i5 O3 v" @! _3 U- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
0 j D! K# S' Q. z5 T) U# ], N
: C% i; D- Y4 ?3 J+ K2、项目改造" u. p4 t8 l6 ?
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:# Q5 Y) n) D3 a* a9 M/ I0 U& Y; ^
1.将package.json改造成以下模样:
7 f% l1 n# h, |! l& ? X{
"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) S0 x) k, h& P$ v3、编码
* M1 T: @2 }! u! S/ X$ |6 Y, Y4 { 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
9 R" H9 S2 Z( O0 A; ?/ c# k. f{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
: T" _ H% J! ^2 c4 k四、调试
$ {; s3 M* h+ V4 W6 \3 R- [ 单纯的开发代码片段的话测试和调试都非常简单:
# u+ G( w6 l" h q2 x- 首先先自定义全局的code snippet。: Q# N' P }) n
2 O8 f9 }9 Y8 P1 Y: w
- 选择新建全局代码片段文件。$ {% r) f6 z6 g4 H/ m4 J* E
( J. _7 L' ~* v% ^
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
$ c* Y7 ~- {2 P6 \0 e
- H" ^! N- E( z/ }" s3 N5 c
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
& C) k8 [' w& ~) [, m
( s7 J4 C# J X2 w6 i* w 生成的代码片段如下:
; h0 H7 B& A0 u% g. g Q# j- ?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; 五、打包
, {; p$ D3 g6 Q, A 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
/ e: G b4 }. S$ E1 Z" w六、发布
# n/ b Y; p+ t4 }" M6 M9 P( M. s4 k 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件! B7 p- t) o- d) j: N! k
% d" |/ s' V1 W0 E% z
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~8 s+ ^! S7 D: h4 g& L
7 f+ K$ R1 Q/ [
七、结语) d6 g. \+ x' [1 X4 L, k% j
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |