一、前言6 n5 R/ w- y$ j5 d1 O0 R& k' r: r8 g- W
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。. Z) q( Y) s. L
二、环境准备& ?/ {" G J% F6 z1 r2 F5 a3 g- a
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g, ~+ j+ D, Q; w8 A5 u+ Q Y9 U) \" B0 c
三、开发者账号申请
7 {: j `) d. J8 x$ P- v3 v 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
/ h2 c( S& p) m D5 B& \1.注册并登录 Azure DevOps。. ~/ ~5 P2 A5 i" T" H
2.选择或者创建一个组织(new organization)。
# x, {0 s2 V$ C3.在该组织下创建一个项目(new project)。
- Y3 B% k: s1 ~6 k# _( [: O, U% W 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
1 _/ w4 \# W( k0 r% \* X
5 K- E( M2 I) y3 j" I0 c) T* i+ M4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。# S0 y+ ]! g0 H! }+ h! V W+ M& W
- k3 p% q, N' B! F A5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。. p+ l) Z3 `' {' o9 D+ p4 R
三、项目搭建
I% u" e7 L( H7 J M% o6 W* s1、项目初始化
- Z1 r. h3 m# @( p4 C# N) T- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。- h% V( o9 H, ^: c7 G, o. W
8 |8 T1 p6 R1 y# a2、项目改造
4 E' d R) U; {* c 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:: C0 b* u0 ]6 i' t! L7 [7 j1 P
1.将package.json改造成以下模样:/ J/ R! z0 k- A: r5 O- v7 Y' `3 S
{
"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包会失败。
: Q: q. b! G5 R( Z ~3、编码$ J; p, ^1 Y, |, @; m( y3 B
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
7 |! L8 H/ g& N; I6 i5 b6 m{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
4 t& P7 T8 m3 {1 w四、调试
+ w! k+ _ z. i% j' q 单纯的开发代码片段的话测试和调试都非常简单:
6 U/ f0 |2 e6 N$ ?- 首先先自定义全局的code snippet。
% j* w& L2 J% ]9 k. {2 W
* @5 E6 Q! ~9 j j6 \1 {. u
- 选择新建全局代码片段文件。1 a& ~- `+ p* }1 k
3 Y+ g7 ]2 t% {
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
' b8 m9 U. \- r+ ~0 {; s; b% v
7 L5 O; I% X# S$ r
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
" U! Q9 ?: a7 _! E
5 `& d! W: N+ @8 E 生成的代码片段如下:
0 ~1 X1 V4 `% ]5 ?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; 五、打包
! h, D) [" H$ U9 n5 Q) M# L 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。/ l7 i2 E/ I7 ^2 A
六、发布
! ?) m# z9 l2 C* g4 U" N 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
! u8 s: N/ q: \- H7 G1 I
& y" d" U& }- u0 l$ k( o7 g! z
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~ u/ z: e q0 u$ i0 \
7 D# n3 [# I" y; K$ m0 d' N七、结语8 {7 {7 v4 j* G
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |