一、前言 % A/ E% Y0 @; U/ R, t) Y! g
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
J/ d; s# A; V8 ~ 二、环境准备 $ d/ M3 n! M2 N* N8 ~
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
2 K. Q& ]& X- Y. U; Y: S) m# u 三、开发者账号申请
$ C2 Q9 Y" t! H2 I( L 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。# m% G5 o: n! l/ w% P* d
1.注册并登录 Azure DevOps 。
% x& H7 d2 p9 h \ 2.选择或者创建一个组织(new organization)。
6 }/ r( s) z' G 3.在该组织下创建一个项目(new project)。
) Y. j* e, C t4 G3 t# G 以上三步都是为了获取开发者(publisher)的token,获取token如下图:& H% p6 o) t' K* x5 D
5 S2 W t. B& r 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
* q9 f& s4 T" z
/ Q- a4 C% ~6 P$ W
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。" O* v) y" R6 w, i( p9 Q/ C
三、项目搭建 4 w, P+ o0 t* z/ O# o
1、项目初始化
& V7 o0 ?2 U# h: Z, \7 J& |% Q 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。3 m1 e l; I/ Q* U' h# h j) e
7 ~+ B Z5 ?5 y! e% |' l. D% K 2、项目改造 ' i6 X; ]; V/ l) D. c, a- n
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:9 ], a u% M5 W6 U
1.将package.json改造成以下模样:
% b) L. b" 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包会失败。+ m# {$ O7 \" @; j7 e
3、编码
" t& m3 ~! `9 }* O8 D/ N! d& @ 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:4 x; L: C: A/ c% i% X
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。0 @+ _" u" U. p: [ M5 F
四、调试
8 y6 a+ Q" T# R X( [8 `1 r0 l. i! v: G 单纯的开发代码片段的话测试和调试都非常简单:
/ p" I9 e9 V8 m# F9 r3 }' {* J 首先先自定义全局的code snippet。
! R. k( J% e: L3 X( a5 |' I' m
+ G! i( v+ q4 g
选择新建全局代码片段文件。
T+ m6 H( a0 B# U H
4 ^. D+ h( I5 [4 p; t d6 E
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。+ f) m9 Q& d4 A: w- [
9 s) ~/ ~! C; x- N command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。. I0 L( ?( z/ C- L4 h: l$ h+ U
- C/ b: D2 I$ O% J
生成的代码片段如下:
j. T* ~% F- V: U# ^ 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;五、打包 8 k; Z! g/ Q7 j% x- C3 K
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
% i1 n0 g' A9 G 六、发布
7 f8 _3 L" R* V1 o; V7 i) E9 i9 Q 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
" c, M0 T5 ~: D# o: n6 o) o j$ `
# D& r& P, D* V) k- k: k 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~4 j( a _) I# X" ?9 f: k) w* E, M
, @7 R$ z9 G" ^ 七、结语 7 A$ f' q2 h* B, H
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。