一、前言
: E; B% S: `2 N) A9 |- q 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。; J' _7 N1 o- I2 O
二、环境准备
: K6 w6 u( V! x. O- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g: V4 x8 y# D2 Y9 g8 N' \# N h% [/ M
三、开发者账号申请
, t1 x# q: _6 x, V/ s% E* Z 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
6 |& p1 Q' W0 H* \2 d" e4 w1.注册并登录 Azure DevOps。7 r. ], C* F N+ P
2.选择或者创建一个组织(new organization)。, l/ B7 F- d# ~2 G" v
3.在该组织下创建一个项目(new project)。* n5 P& U+ J5 |# }
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
7 A) u- _$ s% ?, `
6 ~' n( B+ X+ C' D* |0 X; i* r
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
8 k- u9 ]$ l7 |7 R1 x; J
4 u( D& l2 s) W* [
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
! G, a9 ]! R+ T' i" f' I三、项目搭建
9 [3 c- A# c0 _4 K% L: _1、项目初始化
" m) z' [+ i! n: c- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
; [( m7 L/ w, X/ p ]( [
; J5 U1 o w& U' x% x6 f2、项目改造
7 t# ]0 x) l5 s 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
; c9 G2 j/ H/ R. H+ h: Z1.将package.json改造成以下模样:, c( P7 [, M, R9 U% t" ~
{
"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包会失败。7 i6 G! j6 w& P# M$ z
3、编码8 X& w( z |9 N t* ?& k4 T
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:- m" ^3 L; M9 E$ @. ~1 u* S# T
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。: u0 D& x |8 g
四、调试% z2 F4 u0 _: x( s6 Z! D, B6 |
单纯的开发代码片段的话测试和调试都非常简单:8 }) K3 j8 s- z, K
- 首先先自定义全局的code snippet。
( n7 y! g6 s9 I4 C! t, e3 u. z
- m Z9 R2 N( t7 k0 o
- 选择新建全局代码片段文件。/ i8 v- y% Q3 o' c& m2 F: t5 A5 j
k" s6 u/ ?4 K
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
+ i2 h# u$ G* c1 C* w! J
7 @) ]6 {- }6 B- W2 p
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。: _0 m. m( ]5 G4 U! b
& ~9 K1 P, A( ~" j 生成的代码片段如下:
. s" F4 M) ^2 \# Limport 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; 五、打包
+ X3 {4 T5 \$ a2 j 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
% S- `4 l: ]# i( U六、发布8 f* u- E/ v; S6 a5 l( r& Z
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
% i# J8 @. n. Q+ h
- K* Z6 R3 _+ X3 S( G' H4 ?6 {
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~6 {7 n3 c& s: _* s. A
$ X/ @ F- c4 ?+ N. A七、结语2 N+ T& I0 `) s4 D$ }, i5 @+ s
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |