一、前言
' Y+ `. d6 m7 i: v3 N 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。# g& X+ B! w) @) o- A. f
二、环境准备
+ c& K7 Z1 f( h9 y- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g- I+ p) w; M6 A
三、开发者账号申请
) p' t6 g& S5 f 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。' E: Z/ k% i; J6 ?* ?( o( ?- U2 d/ w9 v
1.注册并登录 Azure DevOps。: ]+ j5 W0 V! \% x' ?- [
2.选择或者创建一个组织(new organization)。
0 K [: V! U& `% w3.在该组织下创建一个项目(new project)。: d7 _% R; H7 x# l6 o( |) B
以上三步都是为了获取开发者(publisher)的token,获取token如下图:9 Y, W0 `& P1 N- Z' q, } [
% d$ f: ]- a* R) T
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。9 q C- y1 p- A1 d& Z
/ z% j: o. x6 W9 ?% W6 s5 q7 e3 Q* J6 o
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。) O0 j$ B3 S$ Z7 m* {* F# f
三、项目搭建
6 E" H7 E( p, v: b, Z1、项目初始化( a( `$ b9 [3 e1 s: ~5 w) D
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
7 ]9 X6 f- Z+ M: F' I
5 U9 o9 s+ w( |. X0 n2、项目改造
$ Q7 t. [; } L) ^' \! V0 \. | 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
8 B) p# _% m2 \; T m1.将package.json改造成以下模样:
/ n" P4 [% {7 T/ I# C, E{
"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包会失败。
" Z3 P9 j5 h$ J' D* c% a) v, q$ I3、编码4 k# u9 R# w. c/ o5 c$ H
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
. m0 z! M$ N6 Z* K1 d{
"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 R* U- s3 V8 s$ }" m' |! D- p* r
四、调试
* j- A; B8 S/ O! i+ d, \ 单纯的开发代码片段的话测试和调试都非常简单:7 E) l% [) I; e, x# r' Z
- 首先先自定义全局的code snippet。' O6 X, A) w u
$ p: W7 T3 f5 F# k# B- 选择新建全局代码片段文件。
! I% |, w G$ a6 j& W! e
& j N5 t! ^5 N- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
8 l# z/ E8 T5 V8 s0 y6 f) f1 _
, e% D, q" M+ a* M* D' V
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
4 U* B$ \2 @5 B: w
7 D3 g/ j1 s4 } 生成的代码片段如下:
; P" w6 d. `, r4 ^1 D$ b7 Dimport 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; 五、打包
: E6 J) B) G. |5 @) i) q 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。; r) U2 T# h8 _
六、发布4 ] f: g& V. t: \
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!2 L! P4 c8 \0 ]7 X8 i% U
7 H# {+ }3 h. y+ u% u- ?/ \
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
+ Z- u& v3 T' P; k5 p
; ^& m. u4 V% h. h
七、结语; N7 _! [/ z& C) \# C4 e( T) u
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |