一、前言
t) W0 T4 z$ Q, A, X 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
6 x" `4 o# s3 R* [6 z二、环境准备- A' j9 ]% y4 m! h. X0 K) ~
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
3 i, b9 W0 r8 J5 Z 三、开发者账号申请
! \7 q2 J% K. Z) w 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。* x% Z' p, t9 O9 u3 A2 \
1.注册并登录 Azure DevOps。3 o! H2 b) |7 V o- Y
2.选择或者创建一个组织(new organization)。; U6 V6 O( h! `
3.在该组织下创建一个项目(new project)。1 ]! C. s1 k1 P/ l) {
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
* R) M4 h4 h% N6 z+ [; U3 M
6 r5 n! M/ r6 E# @4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
$ T; W8 ]& s7 M" G
' R+ S- k, F. m% @- k5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
) v( X; f' ~& o三、项目搭建* B, j* p* D9 Y, H
1、项目初始化
1 \1 y) [, [% e5 U" t, u; S) G- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。- Z* ~0 h0 l* k0 c+ n
9 O: B4 f) ?7 T* j( u; P2、项目改造' m0 e& R' l8 A8 W v, j" ~
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
- |: ]- | p" r: S& N% l* l1.将package.json改造成以下模样:
8 o/ u* [& C) Z# `& U{
"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包会失败。
* s& j7 z4 X, P Y& \9 S G7 o3、编码" j( F7 p o( w
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
0 A1 y5 e* U0 Q+ J4 E2 a7 [% k{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
- p$ P+ `# O: E' e- D四、调试, M% y; \9 r* D& ?& p8 ~! B( S! H7 Q
单纯的开发代码片段的话测试和调试都非常简单:8 t: u7 \ m% w0 s
- 首先先自定义全局的code snippet。; l4 w% G' G0 g8 Z/ R" |6 _
# `/ k! s7 E* m' I/ X Y- E
- 选择新建全局代码片段文件。9 P2 a. z4 v, |& t- n
2 m; X3 ]5 L% z1 [# K
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。, X, |. F5 ]- H# z% V* ^
. N- A6 o& Q$ h; x, h
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
" H9 r% t- m2 m( Y# y* M
$ ?" e0 `0 N3 R) S3 Q- I
生成的代码片段如下:
% R |% f0 A2 Eimport 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; 五、打包( H1 y* @$ `1 W' S) N+ u" G" V
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: u+ M; b2 f& d5 P: Q, D
六、发布: m5 w/ A1 q, |. a. d
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
& O, a9 ?* F- \3 [' I0 H% _; l- y4 \
/ [2 P( ^2 y1 e" |( z( ~! H9 P7 c
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~; t- J* Y' I0 |2 X
' Q- `' Y! y4 u" b3 t0 t" ]1 C
七、结语. n8 ^8 l4 t, m/ F/ v
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |