一、前言
/ y& E3 V" A2 z& |5 M1 T3 d 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
7 L8 p5 P2 W+ ~, ^- d, m二、环境准备8 w% K K% O, }0 Y- c
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
3 B, [+ i! E. o! _1 ^7 V- F 三、开发者账号申请
; a2 `$ X0 J S2 C; r3 F 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
" W8 `& K R+ a3 x8 d! z1.注册并登录 Azure DevOps。, I2 |- s* r; A
2.选择或者创建一个组织(new organization)。
2 Y% w& R" ~, B0 u- W9 H) w3.在该组织下创建一个项目(new project)。
- j* W- H. q/ o- n5 K, `' `5 B, y5 S1 ~& ] 以上三步都是为了获取开发者(publisher)的token,获取token如下图:+ X7 G/ c9 `/ K$ q* n0 q! R; y
( a0 M) n) j8 t0 L4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。% N+ R$ U! _6 L: h) `! N
3 C1 k+ H+ Q, u9 r% H4 P0 x9 Y0 y: k5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
* [+ Q- p6 M% o- c# [1 R三、项目搭建8 p( R& c4 F2 z# N
1、项目初始化
/ ?2 ?/ s) q: t. {- v9 Z0 h- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。: Q0 [7 w/ r, }- r$ H
9 ^, F* g" c) h8 v4 H6 n! A
2、项目改造8 E% G. t4 T/ A; m( Q) K( `% x7 Z
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
& u- j/ M, o5 U Y- Y% ~1.将package.json改造成以下模样:
/ P/ l5 |1 g; \* G{
"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包会失败。
4 E) X( S# H' S& P4 w3、编码
# j z6 [7 x9 F) `( X5 A% ]5 G 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
# `0 U, y: i5 r* f6 f3 ]- [{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。$ u5 L) E. ` a U6 W8 o; W- ~
四、调试, M5 J. H' T4 j0 C6 C% @& `
单纯的开发代码片段的话测试和调试都非常简单:' l2 z) v! W, ^9 v
- 首先先自定义全局的code snippet。9 W8 _# q8 [5 M# m& ]9 p8 c
: x( q9 e+ ?0 `; z/ H! [5 h
- 选择新建全局代码片段文件。
/ P E4 f8 S$ Y* l
( v' R3 ~# S+ |& V- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
9 T, a8 i9 O) ^3 ^
" A; q' F8 i6 m
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
8 c* W* X Z6 w! ?7 y; r
3 [6 Y4 Y: a% I2 e* e' {
生成的代码片段如下:. N. Q9 c# O% |" l" q% Z2 |8 e
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; 五、打包* r, J8 Q4 v& y0 W: d
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
% f9 ~% P' n$ t. l5 q六、发布
# D$ J3 @6 `! {1 i6 s: N1 {2 P 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
; r) D9 N+ O1 q+ {9 q) P7 C
: a D' I% I. K/ H7 s, R! x
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
3 M4 q# Y& I5 p
0 Y* \6 g* U w; q8 o) M
七、结语$ f% d$ I- x8 ^; w/ o; y9 z; M
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |