一、前言
( |2 x u, Q" P5 ? 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。! q y9 x. d8 Q4 y b( [, ~! j r
二、环境准备7 c m8 a8 R/ z) \8 E4 W' b
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
. [. o! [! S8 K: w/ A$ Q$ s 三、开发者账号申请
) `* H9 D' L0 { 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
0 p+ Y7 X1 f' \5 m1 ^1.注册并登录 Azure DevOps。
% P, W2 [) J$ D: \) I- q- k) E2.选择或者创建一个组织(new organization)。
& o2 P- C2 p5 k* r3 I N3.在该组织下创建一个项目(new project)。% T- l3 w; \ d! y
以上三步都是为了获取开发者(publisher)的token,获取token如下图:* ?( v% s# H+ x* L: }- N' n3 d
' I! z+ d) ~& [9 r
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。7 D* S% W% m* _- O
0 `; D4 K8 B/ h I1 [
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
" o p% y! M# L三、项目搭建
3 K8 p. H: J+ L. u+ O8 K! I/ t1、项目初始化3 b7 F1 L- ]) y; Y9 Y. U
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。9 v+ B+ U0 f5 Q# z: M) x( ]
% x0 |( A# p3 M
2、项目改造
- G) q* t1 d) c) P+ V 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:& ^6 J5 E: X$ y( l! `' ?% A
1.将package.json改造成以下模样:4 W4 g0 D8 a* H( s+ a# |
{
"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包会失败。/ u9 k8 ^# o0 I0 r N% ^! h9 [7 b2 A
3、编码
' A1 J2 T( Y$ U2 H 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:. R# ?4 t' b3 [/ m% F1 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。) X: P: g* H! W7 X
四、调试
3 W& {# U. [- c& ]: E% r6 Z6 Z 单纯的开发代码片段的话测试和调试都非常简单:
# D3 r c2 g- @8 R: n0 J3 J- 首先先自定义全局的code snippet。
9 c( f" ~/ H' u) w
( M: M. m$ G! @0 z! F5 R8 K ?& l+ ^
- 选择新建全局代码片段文件。
, a2 J+ \! t9 ~% W; m' j- h
7 I' l/ `) k6 J
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
8 G+ I3 M- Y. M3 _; L& Q" f
+ [# I% ^1 o* H! z% |' O0 D4 [
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
* T9 w0 f- B. t9 I
' V6 c# f6 K9 u4 D+ x0 l& [ 生成的代码片段如下:
& B$ m$ ]9 N1 @& {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; 五、打包" u* \$ k! P4 f6 O9 A/ I0 l# D1 V
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
* x8 f% I! A, T# u+ C% ]+ }六、发布/ W0 |5 A% m& L6 F5 J) {) g
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!: f8 c' H# S0 @
; `- f0 S. ]7 O; N 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
/ @- L5 y b" \. F' H- c8 w$ Q
/ b) Y1 b/ Y8 W: v$ m0 p
七、结语+ M" q8 k# w6 U; s
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |