一、前言5 {& c# Q [4 g) a! X
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。7 p) i/ f3 r, X. m
二、环境准备- n: I! ], H* L# q8 }. J3 C
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
4 A" C( L% z5 e1 y6 I8 E% ^, k" s 三、开发者账号申请
8 W; `. h: k2 ~0 u' n% g 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
! ]& K% Q' G4 L: `* ]6 W& X$ i1.注册并登录 Azure DevOps。
( i6 b I3 R$ m0 l* K2.选择或者创建一个组织(new organization)。
4 `% T$ P, ]& s" _" g3 b3.在该组织下创建一个项目(new project)。5 M: n" W- ^1 R6 I; k
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
5 ?" ], h( O! w5 x6 c
- y5 D, q9 f; T4 B
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
0 ~) B: R+ d* h9 Y% x7 l0 C: ]
" T9 `# L& W( R# F. R5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。 k5 Y* p! h$ Y' v: b
三、项目搭建
" U: }1 E2 f: F! p( S w1、项目初始化
. H- g. E1 g- v. A( O- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。4 d9 `8 d2 \6 V* Q6 a5 m# I4 e8 V1 @
. t( E+ O7 f" ]. [2、项目改造
9 f8 C! O5 O0 j) k3 T0 {% A) V2 q 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:/ h. E- v, n' ^0 W
1.将package.json改造成以下模样:
& Y9 m0 `* x# Z{
"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包会失败。. Q2 t! d g* H
3、编码) V$ @8 t v; B2 X6 n- n; X% I
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
# m* o, t7 T7 N* p: C4 r{
"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 }$ u% l7 I" ?) J; l2 N7 Y四、调试
" |% [$ r% ]) J" c) @; b8 h 单纯的开发代码片段的话测试和调试都非常简单:
7 D; w7 j6 X- x2 `- c& @' T- 首先先自定义全局的code snippet。/ \# K! ~! E" K4 M) H$ \
6 J( P/ ~+ a6 Y0 I) P0 z3 \
- 选择新建全局代码片段文件。
+ G' L3 O/ e T- Z% |* T6 X
- n' d9 ^* R$ W* {7 J9 @+ n$ q6 |
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。( Q/ |+ J6 A! s
! l% k1 J- L( l4 y* h- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
7 Z7 f0 p+ g& I: q' V# p" m
$ S% v) X/ X$ s4 a# u 生成的代码片段如下:
3 {6 u2 R+ k+ a* S) Yimport 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; 五、打包# }$ ]& h5 [( V
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。& w+ Q; `8 a) {
六、发布0 t% `$ M" ]9 ?& l* e( e. M5 q5 r
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
6 j- N2 Y0 j5 C3 u1 T! A6 a
. F) \+ H1 r0 u: `' h, R
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
/ ?! {; _# X2 U
$ T2 F$ o/ j; S1 G3 z& N
七、结语
1 ]( U1 k0 i1 {& |$ Z& _+ k vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |