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