一、前言# p5 [3 B9 \& p7 u* I
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。 h) \+ T' Q/ t2 L5 e' E! q) `
二、环境准备+ E9 K4 k5 @, C. ?7 |: e3 t8 R
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g8 G& Q. Y! Z; M6 E, g
三、开发者账号申请
+ R" ]& A2 k# u9 t1 j- J; ]& H 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。0 t o$ O/ M4 I8 F9 E( k! l0 ]
1.注册并登录 Azure DevOps。+ Q4 m0 ?# h0 `8 G; b
2.选择或者创建一个组织(new organization)。" n5 Y! V1 m8 O& O) a) Z5 l
3.在该组织下创建一个项目(new project)。
& ^3 h# m" A7 P1 C! X& s 以上三步都是为了获取开发者(publisher)的token,获取token如下图:) Q- W9 Z, D+ Q* O2 B2 G% {
2 ?, A e# D$ `+ M' V% V" x
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
, e5 D+ t; `% S$ b7 q5 S6 z
6 ?+ b' T/ x! W1 e! z5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
2 a. Z; j9 U H三、项目搭建
1 m6 M/ c, a7 d1 I) ^1、项目初始化) A" w3 D* J$ M `
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
- q) j$ v" o- _, c9 ~( ?8 k! T
u, E( C2 E+ b" ~( w+ ~ }2、项目改造
5 X9 {/ C+ s! S4 D! ^) E9 y 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
) ^+ c- T2 P0 q# ]' @9 k1.将package.json改造成以下模样:
# g; j8 P4 q8 ~ y7 R( ^{
"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包会失败。! M) X, ]" Z/ E. b; u; T; P
3、编码
& g( |5 B6 @% a8 n4 Y. X: n; g 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:6 |8 f' Q) ]" X( V) c, D+ i% l5 B
{
"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 P% c3 { \# O. V P
四、调试( w* R, R1 a6 ^
单纯的开发代码片段的话测试和调试都非常简单:
9 c( C/ K: X9 M8 R- 首先先自定义全局的code snippet。9 C" ~1 U& l' z3 G$ \: G5 d
3 g2 E4 u. ]- I' x \ e
- 选择新建全局代码片段文件。
0 q' H% S) d5 y6 Y2 _5 o* ]
5 h, I, Z5 h$ u/ ?/ S7 o0 d- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
& i! [3 O* m1 _) n( N# @
5 q" a L4 F* d! d
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。: n: K- J, C" R* o3 ]* f6 r
2 g- C; R0 \$ B$ B. f7 w; o
生成的代码片段如下:
: B1 i. m( D" b3 {% Iimport 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; 五、打包2 I( `. K0 u2 o( P6 e' s
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
: r1 O7 I' q5 y+ O* I- ~7 |六、发布
; A+ v, E4 @ g% [ 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!! w) r2 |7 H; W
- J0 {& l, z o8 B4 w. p6 N
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~2 z3 n' ` ]0 S! a! r: q. a
- g: f8 K% O; m) ?七、结语5 o$ K( ^5 c/ T
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |