一、前言
e! `" K: ^, T; A1 } 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。3 d" O+ h$ {2 n* T9 i# j; [5 O
二、环境准备+ `: H# F! Q( W. A0 _
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
% [: y" Q$ O- t& G1 a 三、开发者账号申请2 R: ?' K% ]- `. o2 M" V. ^2 D
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
! _( v- J( D( V+ P$ ~* [5 U; b1.注册并登录 Azure DevOps。6 q# t9 _7 u9 ?6 b
2.选择或者创建一个组织(new organization)。" m+ k) }; w5 X0 k/ o" {- q0 ?# [0 v
3.在该组织下创建一个项目(new project)。
5 c1 J5 [5 y3 b! o. B 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
6 F( q2 J% p, `4 G( p, m8 X
) j/ v' d; I/ _0 I9 L" S4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。 `8 w, P0 k5 v; _' J9 ?
; @/ Q" [0 L: e7 b5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。5 w. m. W/ {! X& f2 E ]
三、项目搭建- }- O; k. N, T9 N% Z$ E$ }
1、项目初始化
$ Y5 z. v$ X+ O5 e- Q4 s- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。, A) r! d; N1 K3 k2 ?7 m
4 e' U6 [7 `& ?2、项目改造
6 [2 B9 K5 A9 F! X) V$ ` 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
* M/ ~% b8 o$ k* w1.将package.json改造成以下模样:: T: f6 l& v A0 i# ~+ y6 u) 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包会失败。
/ N7 c" b8 G" g: u4 T3、编码7 B H/ w* t+ F' h* `5 ^3 t
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:) }2 ] o- r C7 ^' J* A3 O
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。3 z$ K, S& i% }5 W8 N
四、调试
$ {, v% J6 P( z) Y( c 单纯的开发代码片段的话测试和调试都非常简单:
3 I9 x6 W M: x- 首先先自定义全局的code snippet。8 Y- ^( X' h6 s$ _! A( m, U4 u
0 f: h( v% o- i4 L& |. C' h$ s
- 选择新建全局代码片段文件。9 z* o' h& j7 }' N
' m1 R- Y$ p, ?! I
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。( k$ v+ g4 `* B' e) I4 x3 y
9 ]) g o* N! V& N1 V" I. [% ]- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
( j* C9 [2 R) u* I3 G
$ \% o" t# i1 R! H$ v
生成的代码片段如下:( r, L" {1 C& f7 C& t8 Q: o& o
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; 五、打包; T8 q, w* I Y6 c0 T7 P
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。+ X1 p# Z* ]) \% b
六、发布" ~* U2 v. L, _3 M2 x1 I% W# n
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!! M/ N2 }; A, [1 U# ~* s O2 U
. Q8 Q& y8 s4 M6 o& h/ p 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
2 f3 v- d, P9 g% o6 L
, _) P1 `' Q! `1 g
七、结语
) e4 X+ [7 J4 R vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |