一、前言, x: ]! P# B7 Q5 i! |! q
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。2 M" }/ T. w; H5 k+ \- M
二、环境准备
3 \; x t$ Y* L$ n- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g! W$ G X/ Q8 N5 ?7 Z# c$ F
三、开发者账号申请1 W4 l& X, H7 z& T/ x
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。2 ]/ t% d# |: N; `9 d; m3 |
1.注册并登录 Azure DevOps。5 ~& K( i" h0 ~4 w' _8 W, }
2.选择或者创建一个组织(new organization)。
/ A8 ?. _ B$ a7 h* f# c s" Y1 N3.在该组织下创建一个项目(new project)。+ `; Y5 \- u& O* J' c7 d* h0 t! G
以上三步都是为了获取开发者(publisher)的token,获取token如下图:, b+ |7 d% a1 x
% L `* @9 E/ E% f, q
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。* L' f5 g3 e) T! p7 s, `
! ~. G4 m% \0 Q" I ~0 a* L
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
2 v/ M, u9 _$ @4 O( r8 l三、项目搭建2 d6 ]: c8 b3 \' P- w
1、项目初始化
1 {; S- X( P1 ~. [0 n( F0 P/ t- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
! Q e2 k$ z; W* B% O9 ]& D! A
5 g3 k: r/ p7 J5 A: {
2、项目改造+ x, Y2 R! `2 g, E# ^
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
3 S4 z) P/ G* r. l- ^1.将package.json改造成以下模样:
$ v/ Q! I5 G) w5 d# z. f O( B$ K{
"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包会失败。
y. p- m( F: S/ W6 k) C d3、编码
' i# f' h9 _* ^" S 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入: c6 M' E* A0 j& \
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
, e, S/ `9 v# f* b/ I四、调试
& o' ?* n' C1 c3 _$ t$ H/ f 单纯的开发代码片段的话测试和调试都非常简单:
1 i+ ^1 T& i6 C- 首先先自定义全局的code snippet。! i& ]$ j9 @7 H; @
. }! z* K2 n4 v( ]; a8 g- 选择新建全局代码片段文件。+ V3 r) }9 }% g* R
% ]9 n: k' h9 k1 P! K: z! @- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
5 _2 ]; {* G3 I* _9 f
0 R: L4 G3 X! L8 A8 x8 ^' c- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。2 [( U5 H5 o( x
. c. Q% ~+ S) Q m/ z+ v1 m 生成的代码片段如下:
6 O- V# u+ h! _& Vimport 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# c5 }( `" C 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
$ B3 m8 ^) P+ k I六、发布
( X: M$ p P C* H- R 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
0 T; y3 ?) B O& ^* f7 ~! f
1 b& \3 u* Z* B: _! M5 j4 Q7 l$ u! f
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~: Z% u& |' x" ~/ t+ ~( ]& }# {
1 H% y1 E) l$ n* d- @
七、结语
$ D3 A+ C& C& e/ C) p9 E vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |