一、前言8 x5 u) I6 R* |" w0 p; K+ b8 r
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。: D! t- s& N8 U% l7 z
二、环境准备
& V( w" s1 F- O( z9 J- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g( h: ~, N% T( e9 ]
三、开发者账号申请
! ^& R0 W+ T) Z1 k& F) F 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
, x" |7 C! `& T# K# F& }1.注册并登录 Azure DevOps。
7 n* \% G! A! D# A L ~2.选择或者创建一个组织(new organization)。) B0 j# N/ w% ^' S& `+ Q
3.在该组织下创建一个项目(new project)。
" x! b; g, g: l' k2 b1 [- |( M 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
4 ]. u5 ^1 W7 Y& y
B/ d z+ R1 e( W! b4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
! A% Q. l9 W" g6 J6 ?
. r. b0 f+ Z' X7 ?: g% h
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。# r/ y$ d# h1 \
三、项目搭建; ]; O+ g0 Q; ~0 }7 A6 M
1、项目初始化8 W5 q: R N% H1 l8 r3 o1 R y
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。' {+ p Q7 L( W @6 B# \# p4 ^
/ O8 o5 V" l. W( f5 n% I' x2、项目改造* y$ K( R) r: B; g1 Q( ^6 r
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
$ q; j6 K2 l% e7 E& t0 r1 h1.将package.json改造成以下模样:9 L( |3 ]0 k; h s7 f1 @, d
{
"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包会失败。$ W: t! m: P5 u9 \% Y7 h0 [
3、编码
3 ^. P3 Y9 O% P 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
) H9 G) o1 k7 P8 j7 o0 {{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
4 }% f4 @# |/ y7 Y$ M: \: b四、调试
5 Q$ U6 g% C W# B+ r 单纯的开发代码片段的话测试和调试都非常简单:" d) B# E* I1 H: I# h0 q
- 首先先自定义全局的code snippet。' v2 `# W1 _5 v4 q8 |+ j5 F
& V: o$ [. \7 a/ b- d
- 选择新建全局代码片段文件。
: ?; a" f9 H |- B
0 {6 T2 M* q& G4 U/ S5 U5 s
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
$ s0 W7 d; U M/ s' M& T' p
2 |! l5 I: W3 }( _$ X* o- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
3 |5 r5 g5 j* s' v0 s
+ K! P$ Y2 Z( Y1 H: ?
生成的代码片段如下:( X% a! P1 r$ x3 U, Q, 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; 五、打包
) @- m: s0 p( h6 y/ ` 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。3 k- H4 Q7 }% K$ r
六、发布+ P+ e/ t( ?' g, N; O
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
4 Q5 ]2 O& L/ a* U' q, r
m/ M/ p5 ]8 }; z3 G' R
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~; U# N h8 B1 w+ Z1 r1 E8 [
0 X) ~) o& o- u S" E' s2 @7 F
七、结语/ c1 E- l% T1 G/ G$ w9 w- f8 K
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |