一、前言
8 t1 J4 m1 i( H: P# r 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。6 f/ E6 m# B, t! \2 S5 N8 f" I' r% w
二、环境准备 ' b5 K* G! }2 e0 Q3 e( ^) w! x
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g2 _( ^% x2 ? M9 `
三、开发者账号申请 + x* D' @8 [9 c1 Y& c& t
点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。+ ]' K/ p* d* e& K9 u
1.注册并登录 Azure DevOps 。' |* q! B( y7 I. A" b& i
2.选择或者创建一个组织(new organization)。9 s3 N- p# F0 X
3.在该组织下创建一个项目(new project)。
( }1 Z) s0 [! v7 L0 \9 C& f 以上三步都是为了获取开发者(publisher)的token,获取token如下图:- d; P. S4 u& z
3 }% Q- @; }" z% l [& M( Q7 Q 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。5 @3 [# p, G. ] X; f! M# ^
* F- P1 s% m) Y# Q 5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。7 r& T8 K8 J; W7 d
三、项目搭建 6 a+ W. L" }0 i) i' E$ H" Z
1、项目初始化
5 T; W; d( Y- d 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
, W5 q/ o) M* g. |
0 ]8 {9 l$ ?: _: @0 W 2、项目改造 / R0 }* c. D9 ^# a
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:& \' O8 {% @+ x, i5 o$ x" j
1.将package.json改造成以下模样:
; X1 M+ B% H* h! ?6 l% 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包会失败。( |& C. i& }4 c" d0 ]- F0 u
3、编码
& T s5 }( l4 x. Z 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:% U; Y% G/ ^/ N i
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
, t2 j# I) f! [; M 四、调试 , F8 n% W; R- l; t7 g, v$ q
单纯的开发代码片段的话测试和调试都非常简单:( C- [ ]+ `' N$ k; e5 A4 p
首先先自定义全局的code snippet。
0 I* `4 d2 t! e4 F' h
/ ^/ E- q `: o8 a, h8 P& v 选择新建全局代码片段文件。 ?' s* k F% f0 W4 b
7 E L! |/ X( H 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
& X5 e' |" o! x9 T& x' v
- Y# H: o. [( I8 [5 Z
command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。 \( y7 _- v: k- O, O; P
! j1 ~/ F- J6 ^/ i8 Q
生成的代码片段如下:
. P2 ?5 k; M+ L" S$ Y 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;五、打包
' ?* S3 J/ Y( Z 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。5 h& @8 Z/ B4 C" \- p
六、发布
( }8 \5 e# j+ m0 |8 ~ 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
$ H- B; ~6 `3 @- k1 l. Q8 J/ @
8 @' S& Y# ^( L: @ @
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~# E7 C9 v3 i* ~: r, y/ c9 v
% `. B5 Q$ s+ f% n' p 七、结语
3 ?; t0 e. Y2 d9 }" R% _- f vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。