一、前言
( z$ M+ @" Y$ V4 H$ D+ | 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。' w$ y' I2 m+ U# `! M: B
二、环境准备
5 J _8 x! u% U# l* T- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
$ ~/ R1 w% r, ?# S4 f. _. E 三、开发者账号申请( m# J% n( [; ?$ Q6 n
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
: _( y0 |4 X5 j7 ?5 G9 n; U* d1.注册并登录 Azure DevOps。7 W: I- _* J2 P$ a% R# O
2.选择或者创建一个组织(new organization)。
. P3 e) n8 x* B" g) C3.在该组织下创建一个项目(new project)。
4 Y# H8 v" Q4 o0 n' [ 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
" l7 L; \4 k( h6 l& p6 s% y) x! r+ {8 O
9 }+ L% e7 |) Y& Z7 v( B- r( c4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
1 J) L0 O1 b! }/ X) K
# R8 j( L2 w) T
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。: i$ ^" o2 q% _- _! p
三、项目搭建( p9 x) r( h. _7 j' N5 z
1、项目初始化: U' G" F+ @3 O
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
; Z* @) f8 E1 J# K
' J( F) g, z5 g+ J1 I
2、项目改造) E! b( J, n% z" j* E& C; t, r
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
* G8 N. g8 j$ m* X) v1 N1.将package.json改造成以下模样:
4 M$ H$ i0 o( @6 b1 b1 K+ G{
"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包会失败。
# H3 \8 V+ R; `1 d4 k3、编码
2 x! p; ? r8 t; \ 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:5 e W2 P; Z: T/ z/ m* C8 O
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。5 C/ ]: {+ z5 Y* ~0 w+ P v' }
四、调试# b+ _6 f$ x5 E5 w+ ~+ {
单纯的开发代码片段的话测试和调试都非常简单:
+ v6 f. w/ n: ~6 M' i- 首先先自定义全局的code snippet。1 W2 T. Y: @0 E" S$ r0 m& K4 w0 b
$ F0 t% r! y% `- 选择新建全局代码片段文件。8 X; x9 D. t8 v. [, S2 p
1 P; e% o0 M6 N; U: e& G
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。" z6 ]: Y, V! a* L
. S: Z! Q2 c) k! I( I2 t8 f1 `* x7 y X
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。3 K5 |" ?4 s7 _; B* K! N
0 n0 i3 Q" _9 n% r& L 生成的代码片段如下:
: g2 y) t1 f$ f7 z+ c0 H% ximport 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; 五、打包
u# v! h6 x* X s- E& a. k 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
H) z) w. ^. L; I5 z f六、发布 }: p# ?$ _ K i0 A
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
$ s! t7 c7 M* x, x( ~+ i" K
8 C1 R5 @. ^3 i `& [8 k
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
( @6 b; J* {# d; o5 g" o! a
5 z5 o2 b9 L6 M- ?七、结语# v- J5 q7 ~1 n2 y/ E
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |