一、前言6 u: L9 r1 J% U# |7 x# o7 Y# }
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。' x7 v. X# ?7 }. F
二、环境准备1 H+ w1 C& u, b9 F
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
/ V/ L c R# L/ K n 三、开发者账号申请
3 f/ r0 \( Q$ z( X: V 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
3 Z5 \; t. R `4 E1.注册并登录 Azure DevOps。
# w; b& S1 @2 B0 B2.选择或者创建一个组织(new organization)。7 I# ]3 e1 Q% M$ `
3.在该组织下创建一个项目(new project)。( N& ^9 m9 `; O. c, v( q- c/ z
以上三步都是为了获取开发者(publisher)的token,获取token如下图:: V6 h6 T/ \- `! y
8 l3 l* u1 w& W8 @, N4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
% l7 H- F J, v
9 w! ], y7 t) H' Y4 N! S2 E! t
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。# H* @6 L8 n0 g, J+ I3 t6 M
三、项目搭建
5 Z5 W- z1 Z' T- I9 H1、项目初始化
0 C3 }9 k* m! f8 ^" x- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
, x3 u% g3 [, U7 d! q& x
( u1 O: n5 r% W) O2、项目改造
. K I! _8 q4 z6 o" f% G 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
5 m& {, L( m, _1.将package.json改造成以下模样:3 w1 q! e: R) r" I R! d; V
{
"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包会失败。
& z/ i0 q3 \6 n, N, F$ U4 [3、编码
" R5 s- B! L0 j4 L% L7 z8 n1 s: t 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:6 ]* z1 _! |: F) l5 E! W
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。& q g3 B4 ^) j7 A u5 D
四、调试
: E3 s! w& Q" s' h% b" \ 单纯的开发代码片段的话测试和调试都非常简单:
# s5 W* h Q* M9 J7 L! O% \1 q! O- 首先先自定义全局的code snippet。7 ^: a, U, | F$ D6 F2 |
1 f6 f* H" V9 p4 |8 |# D
- 选择新建全局代码片段文件。 A5 W) ?& y8 E0 |+ O: ^7 T
5 X7 X, ]( ~+ a7 B/ D8 c. r+ U
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
y0 m# F" M! N1 g
: j2 `9 z; w. [/ A+ U3 m
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。; e+ S+ p) ?0 h# M8 n
( n$ ?: {, W. a3 |7 Z9 H3 J 生成的代码片段如下:
+ J/ [5 l1 e I: |9 F5 _7 r/ [9 Kimport 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; 五、打包2 V* G M1 i: Q# ^( V7 r$ B7 [, k
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
; I: r/ F% v" U/ w3 z六、发布
3 u) G/ m# Z& }- \ 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
: w9 `& ]' U! _
& G- X4 ~: t4 M 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~! v* e |3 I1 A
. F: S4 F0 n+ {) w七、结语* ?( m$ }4 @4 V; ^; f
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |