一、前言
0 |; R! t7 H0 w) F% A* Y" r 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
( n) u9 V. s/ F! Q( W; a 二、环境准备
$ e- s6 I( G# ]! b* l) A node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
$ r; ~% ]4 e/ ~, U* l: x( Y 三、开发者账号申请 % I( {, f9 ?. \" m+ d( b! B
点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
0 l4 y1 w: w: A2 I/ ^0 F 1.注册并登录 Azure DevOps 。0 S3 j2 q! ^ ]+ D
2.选择或者创建一个组织(new organization)。6 b7 T1 X- o* f+ W
3.在该组织下创建一个项目(new project)。
* k; N& t' D! K0 I+ I1 o J 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
3 \2 w* h/ ?- w: C* l) b
2 s& c: u# U# R. F: U, \( R 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。$ o$ [3 ?7 U2 ? u! U
% P( Z0 c+ ?* s9 ~/ N6 R3 \# _! [# h
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
0 C) J! v% ^" B" w( s( q0 r' a 三、项目搭建
+ i& a& r3 |9 J1 } a9 c 1、项目初始化
# ` N. s9 ~! U- H3 z' r+ u: r 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。( j% `+ @ c( X& Y8 m: g: F/ C8 w
+ y" V2 `1 T3 j' n
2、项目改造 8 S; k7 e9 S: i5 s S
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:; f) y/ X, n& L
1.将package.json改造成以下模样:) k: ]" B. J6 H2 M1 y; R
{
"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 \! Q/ @9 @/ X' { 3、编码 $ W% F: x! H' C& x: _
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:/ e2 s! X7 w6 T: B4 o P- T
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
; v! V" K" m9 v' [, y% ? 四、调试 1 F- M6 X3 v' _' H1 Z
单纯的开发代码片段的话测试和调试都非常简单:* `1 I9 N9 t9 S8 r
首先先自定义全局的code snippet。; ^/ v; G3 t: T. n% _% {
K+ a4 B/ e; J7 v' P) J! ] 选择新建全局代码片段文件。: \( H6 i7 }$ F+ S/ x+ I( ?
p9 B8 t7 T7 B: L
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。3 U5 ~' I8 q3 F! q4 D
1 ~" l$ b' T3 A4 X5 H command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。+ D* [- O8 }0 y
; w8 V9 [! w! y; U; I& W: ?
生成的代码片段如下:3 \) J7 q7 G% `) w
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;五、打包 + Z; e4 [& U5 w* ]2 L0 S$ @
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。+ _6 v& u. A" @( N' P
六、发布 ' E) z. Y Z& e: _& ^4 u; K3 A! Y
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!2 a+ \& B. `4 ?
2 p; |$ B$ F C' r/ K" V/ Q
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
w0 W; d [8 a* W. E
% Q6 m3 }/ P) l, ?" V 七、结语 3 v/ n" n6 E! i: y2 s
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。