一、前言
; P+ _" k3 w# W2 L2 K 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。) R& k9 g( g* q
二、环境准备/ p9 m; o; M- @. y: [
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
% f0 h$ R& ^. F5 B5 E 三、开发者账号申请; e* B: K" W1 s! H) M
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
& [6 G/ O. p2 g. ]/ J+ f1 k' m1.注册并登录 Azure DevOps。- t5 X& ~, ^) O2 o
2.选择或者创建一个组织(new organization)。
+ `7 o( B) N4 H* Q: m7 H# K) w3.在该组织下创建一个项目(new project)。0 W, Y, ?: P: q
以上三步都是为了获取开发者(publisher)的token,获取token如下图:' w! Y- X- P" ~- p
5 s* S6 r2 {1 z7 x3 t+ W' l
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
1 N2 t6 L1 ]1 q. o% h5 e
) l ]4 s, s1 f; T/ D
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
p ~* x1 u) ~( q三、项目搭建
) z* P; g# E. k2 l+ i/ b. ^5 ~1、项目初始化4 z* ^: V/ B0 ?, p7 z; y
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。; r4 ?# u# B( f- J" V4 X3 x
/ r. I$ g0 N! w' V6 V2、项目改造
$ ^! I# Q3 B: N" m& {4 } 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
2 D( c7 R6 n& F% X5 y1.将package.json改造成以下模样:/ P5 k. X6 U% o2 d- Z
{
"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包会失败。
& ?/ @% V3 a# @ N" q8 r3、编码5 U3 A% `/ T6 [, ?7 L9 X
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
( h0 ?% M5 s7 z{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
. }( W( _9 l& U$ ^! [四、调试 E; c! [0 f K7 r4 m
单纯的开发代码片段的话测试和调试都非常简单:4 g! |4 ?$ [' L9 F, W Z
- 首先先自定义全局的code snippet。
8 ~$ }8 x( k4 M( p
1 M' C% b( C. f" }, {8 n" h- 选择新建全局代码片段文件。4 v* ^# Q9 d& R. ?
) u" m3 }8 c$ _- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。# r. e6 D4 U( j6 g2 Q5 F0 }
$ \3 t, Z2 ?8 Q7 d
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
/ s/ i% `7 R+ X4 U% ?5 O% l
* L8 @) d5 ?1 m: j$ G4 p+ \
生成的代码片段如下:- p: t n7 t( j; T* j8 O0 G
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; 五、打包
9 K, k; z% }: T b8 `7 [, n 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。/ e; D4 ]$ t" u6 o6 b
六、发布: C! }# x& c5 w& p! Y- n4 `/ l
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
! L; m1 x! V8 @' T& x9 o: N
( u6 N* C8 Y) U, m0 k& }! B
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
) }8 k* U8 @9 A! r
2 o) w+ Q! p3 n: C- l/ P$ y* x" L
七、结语0 I+ m9 L5 @7 r9 z; ^
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |