一、前言
8 T" d7 \/ l$ Q' C. T4 F 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
; K4 E: K. ^4 ~# g3 l1 R0 W二、环境准备
4 q0 _2 t* C8 h# m/ x6 K) @0 i- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g6 ]' {$ u- B% Z0 F% e& L
三、开发者账号申请
2 k" `+ v/ N3 p. W 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
) H6 j y7 A& Q* k d1.注册并登录 Azure DevOps。6 q% v/ F: C. U. ^8 S, K
2.选择或者创建一个组织(new organization)。
6 `& C+ g: J" B% I3 S# Z3.在该组织下创建一个项目(new project)。
4 \0 J$ B6 L6 u+ R, C' E 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
/ a& ^3 C4 c% `) d/ v: f! E
5 X' J6 C& R$ L7 w G$ i+ b9 b& B, l" ?
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
4 r7 Y1 r7 @& v9 v3 B6 N
* R. C$ H/ ]% d7 c. R4 {+ |3 ]5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。& _: I- D* I( f7 I# @
三、项目搭建
& j# O6 q, a/ P1、项目初始化
w0 j* M" I M% R- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。4 M( Z. c9 ~5 k* G8 |
, o: K* h' ]( V% q
2、项目改造
g& |& n8 t6 h, s 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
0 ]2 p2 U# s* h- @/ e5 S1.将package.json改造成以下模样:6 O* j, }- X0 n/ \
{
"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包会失败。
; d, r, n8 j- F5 s G3、编码
4 U0 G- c: P0 ^4 ~% p+ d2 `8 H6 f+ c 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
- O6 _ S/ y: g$ \. m) s{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
$ X" U% h: B1 L8 |3 j0 j" }) W四、调试, V* r( c2 F* V0 F2 O- o: G1 ?# U8 l& ]
单纯的开发代码片段的话测试和调试都非常简单:7 t7 p9 q! h/ e
- 首先先自定义全局的code snippet。
?6 d5 W: G3 T1 X: J" C2 k/ ?& }
' [6 [4 ]% i8 O# y. L, y& I- 选择新建全局代码片段文件。! j7 p$ z) x+ `$ P3 y6 d
/ y$ w) W* e4 R- M) y9 C( o6 T. U% v
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。& n" k4 X+ F2 Q+ M2 e$ l# L
0 E8 B6 W' p. R3 I
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
5 Z ~9 C1 b: [9 U8 g; Q7 G
P1 d& M0 t {/ R) E# v. m 生成的代码片段如下:, i2 }: C3 u' a) M
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; 五、打包5 y% X' x2 r& z# M, {
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。1 g2 Y6 ?: I6 w8 r
六、发布
5 d- y% _6 W" _ 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!: z8 o# }% r* K' @/ ]6 W
1 ~# o; ~: l# M x! o" M 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
, u y u* I4 S" J8 B& k9 ]
) b& H( X* m% B! z) J) c
七、结语
- q: _, h, f2 O- D vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |