一、前言7 i: i* P8 Z: j% ^, l* a, Y, {* u# u
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
% \, I4 y" L# l7 b5 G二、环境准备
. a T" W( x( R8 D) K4 T- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g7 f/ J4 n2 f% n( U2 L
三、开发者账号申请
* Z S3 ]! s( h9 M 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。( I% k8 {9 i0 L
1.注册并登录 Azure DevOps。5 t& N! W5 x5 a) E1 ?5 a1 L/ |
2.选择或者创建一个组织(new organization)。7 G# r+ a6 @" M! N. ?* E# ^0 M7 F
3.在该组织下创建一个项目(new project)。
- r" h& @; S4 l. h" k 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
0 y: b& f0 x% q* N/ E2 V
/ m1 B0 _4 G# b6 l4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
; N- W& N1 F9 ~$ K* l+ I3 ]
, W8 @4 a3 S. d9 \* c
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
) E. }- Z' ?) ]三、项目搭建7 C$ y9 M5 ?7 Z$ ?+ j$ x
1、项目初始化
% S# }2 I4 P' s; g/ d4 _- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。 W* n$ h$ ?" R4 w; e
6 v) l, W3 U( t! O, y3 }2、项目改造. v* j% L- y) g0 m5 {
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
8 B% [& U! W. D5 c, Y7 R' ^1.将package.json改造成以下模样:
( w1 E0 L0 e' y% z9 ?{
"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包会失败。. A$ [& ^* V! U+ W
3、编码
2 c% b# y; x2 ], F' Y1 b6 N0 V/ Z 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:, ~* z6 @% j7 }( J0 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
/ w. C3 d9 g# a0 ?, z. B四、调试7 m# P2 Y- Y/ i/ s0 Z( Y
单纯的开发代码片段的话测试和调试都非常简单:
$ ?4 T+ h& [) A$ z- 首先先自定义全局的code snippet。+ ~: B$ {8 f* g. l
4 J" G+ P) N! v, ~7 `6 b- x/ F- 选择新建全局代码片段文件。
4 K* C, Q7 H# N9 n* K
7 i' v8 e! k1 L# P
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。9 x0 k: T3 N: e- H$ F
* H5 V; G2 b& i, i; X+ v- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
2 _, ^/ n y' ^5 O' [, b
4 O b; d5 M# O( r
生成的代码片段如下:) M# t2 D! \1 |' N
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; 五、打包
, x6 N) N: s6 s 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
9 r1 B' f: `3 g+ O六、发布3 e5 B1 t# h# x9 g; F5 T
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
3 d1 W6 ?; S7 q5 r+ ?9 H8 X* p( m
O9 h. W0 B/ k1 n! G3 `' X: G2 w. L4 q
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
8 }- P2 H, f6 r! C6 g4 t" k
0 [9 N5 i8 ?+ v( d* Y+ P
七、结语8 Q$ o+ B! h% K6 ~
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |