一、前言
( \4 A9 p- `5 z5 j' u 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。: I3 ~ t* O. s# G7 t
二、环境准备
) r }3 X/ v! a8 A( a2 ?- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
o) J3 H: Z" |, ]/ N8 R9 }2 j 三、开发者账号申请4 n, q. R6 E7 J J5 i, I1 ]
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。: u* M z' }" u/ d# D0 j$ P7 p; ~
1.注册并登录 Azure DevOps。' y1 \% `& e( ^* C6 ]
2.选择或者创建一个组织(new organization)。) M* f6 ]& T. s: V3 M
3.在该组织下创建一个项目(new project)。
: u; \' _7 r. Q 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
9 p) u' w. o5 S5 F
! s$ r: P/ L7 N+ e
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。/ Q& K% y4 t! e& U }
# d7 E; A5 q2 i! }& O5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
. @9 j7 _7 \0 t9 M三、项目搭建4 [8 |8 Q# R# S0 K4 [1 t) s
1、项目初始化
- l9 l# E+ U, c3 K* ]+ [4 Z- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。# H! x& n: d8 ]; V$ K' x1 j4 g6 l
2 l! |3 X. D5 i9 Y* t+ m2、项目改造
, Y4 g3 L9 o! F" m7 r- q 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:8 u i6 q: i0 y" e1 M6 Y& o* g
1.将package.json改造成以下模样:
" a2 Z$ f$ N8 C; t6 c{
"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包会失败。- s8 O/ _6 Z& I1 E' B) v2 H
3、编码
( ?! S' o2 r! Y& F9 g% V& p0 A# v 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
2 I! |1 W) f4 t, c6 k{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。' a- V# U; N8 N$ ]6 _0 B
四、调试& e: H4 x7 h' e# ~$ K
单纯的开发代码片段的话测试和调试都非常简单:/ F" R6 u* i" Z4 p j
- 首先先自定义全局的code snippet。, a% W6 j/ o4 d" p4 d! b
) _: k! Y. d2 |1 \6 B7 h
- 选择新建全局代码片段文件。
: s0 @8 ^+ R( }7 d$ z0 O
, F) Z% W3 k- q) \2 l- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。( C/ b" [& [$ W. z2 ?% J+ v9 X
( [" Q: B7 h) D$ D$ t% Q2 v
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
5 j; r) ?6 n) q" ?
) |. X/ |& d" [9 G9 p 生成的代码片段如下:
1 v+ ^6 x$ l' b$ y- x/ |0 U$ 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; 五、打包
0 {: n8 O* Z5 F6 d" D! x0 n 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
; T3 I4 g2 s1 n六、发布9 r( n- Q9 w; K5 x" _6 g* }& ?1 V
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
" t, K- c! t( H% r! }
/ [' W1 L( T# m% Y, e4 T
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
! C1 t0 [' E3 e5 I
4 d. h) J T. e5 u. a: E& O七、结语* L+ T: O! e; `/ Z' D0 ~9 f
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |