一、前言
' S$ [+ y5 k1 z 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。2 [( x6 h# U S8 O1 G& t
二、环境准备. O) R) R! ]2 B8 x0 A4 e. `
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g" c2 d' o- w# B% R E4 b
三、开发者账号申请
( N$ L2 s# c, V4 }0 g% @ 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。( j3 }; Y& V" ~2 @$ K- E% J
1.注册并登录 Azure DevOps。) p Y' T) e: @+ c- f( E! a
2.选择或者创建一个组织(new organization)。: s3 n' Y3 L: s+ {8 a, a/ }8 T z
3.在该组织下创建一个项目(new project)。! J+ z, y8 X: u3 s5 V
以上三步都是为了获取开发者(publisher)的token,获取token如下图:( g( t/ a( a2 f* Z3 r# j9 |1 F
* N( Z3 L C/ h' p5 u: F4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。# B6 s$ p) ?3 J+ E9 O2 }9 f
1 m6 `+ }. a) ?
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。0 G$ p" \- T) C: ]
三、项目搭建9 R. F% Q9 @2 \, R1 `: N: p
1、项目初始化
1 H9 v9 M$ D9 m9 S, ^% G- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
2 ^. M Z7 ~: E; C% J, a
2 I% S; z5 h' d5 Q4 t& w2、项目改造
" W# Z, `( q f( B- @( G2 }" s 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
5 X, l/ V4 |" |7 Z1.将package.json改造成以下模样:( c1 F; n, q9 X) X# ` ?$ 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包会失败。+ f0 B$ f# x! o9 w9 Q p* d
3、编码 ?& e; H! j8 b
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:1 ~( e/ v1 G- E* _$ D
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
6 O* ^2 J$ d$ G/ |& S# E8 P/ ~4 a四、调试* C/ R# r1 a; T9 M, p- {) v! M8 i
单纯的开发代码片段的话测试和调试都非常简单:
2 n' f* e6 f- s3 I& {' Q- 首先先自定义全局的code snippet。
, O- v3 {5 n. p& {+ i! U
' A( W3 @5 U, @9 v6 g; ^- `- 选择新建全局代码片段文件。6 v- n( b9 B# i: W: f
# V* f* \5 }1 d! [ h# L* Q- d+ B- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。- C. A' B( |# {" y
" G# K" m& D% u, b+ q
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。+ F/ |% T! }- U8 U7 A- g2 |1 a( Z! z
7 q' O/ a1 t. f, a
生成的代码片段如下:$ o7 i M6 Q! K9 _6 i2 q
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; 五、打包( a; G' V5 a4 O9 {9 c: ~; n
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。6 U9 [$ n3 G0 W. d
六、发布) Y3 ?1 U7 |3 f4 |2 K$ J* t
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
* \+ t( m) T. \/ h/ y5 h
& T; k3 T' R7 Y; w$ _ 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~+ Y, B- Q9 S8 _5 D- ], f3 D/ I
: M% N. ]- H# {
七、结语, U6 p. C" G0 n$ i) O) \
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |