一、前言4 K& J( o) m2 {/ H' t
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
J4 e) L% {) V二、环境准备
( e, F; Q7 _; M; L" S, R* ]- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
9 ?+ f, n% y9 Z9 K/ p 三、开发者账号申请" @/ z, f) l; l7 j7 C: y
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。9 c* ]% u2 y7 ` o0 X
1.注册并登录 Azure DevOps。
: p- ]4 ~8 h, i: [# ^6 `! }) O2.选择或者创建一个组织(new organization)。
3 t% Z% g9 i" N; N3.在该组织下创建一个项目(new project)。
, z5 O) a ?' o' H3 S- ]) b' K 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
+ g2 B" l+ [) _4 s2 j) |
( t4 [/ ]" v% l1 s) e5 {
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。# e* K* y6 {# H+ d4 Z
1 J. b2 y1 W3 g, R6 D9 U
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。5 I6 |3 |3 N& e! c7 u1 t3 i" z
三、项目搭建/ l3 |' I7 }. m6 u# T* ?4 f
1、项目初始化7 f: q$ h" X8 w' g5 W! x5 S1 s
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
5 Z% L$ @ L% L
( v$ U( N/ V- q2 t# v
2、项目改造/ q2 }3 H5 D# d& E2 r) _$ Z8 X8 |
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:" E ?6 Y' S- \. ?$ a# Y- m! e
1.将package.json改造成以下模样:
( o5 g, R% w. R' C. y7 P4 ]9 g, 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包会失败。
& h. N) n6 Y: |5 [; u- M3、编码- |) X7 g$ q! W( A, E8 [9 a, ~6 h
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:# R# H1 G% e/ s0 y+ n% [' z9 F0 R
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
4 n2 P w" \; K# G$ L) p+ {四、调试
% W# ?/ ^ Y: h 单纯的开发代码片段的话测试和调试都非常简单:
6 ?0 @3 @. _2 @- 首先先自定义全局的code snippet。4 ^+ s d1 }- P
- t y/ r V+ j5 d) F- 选择新建全局代码片段文件。
. z! C$ p- w/ }5 v
% s9 V3 o7 U+ Q! E {
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。7 j4 _2 ]$ i2 o5 Y D& l8 {
3 b9 W, D. E9 ?5 H+ J$ ^! ~! E- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
6 H4 A) i3 h+ Z# f' q8 ]: e
# m, ?' P0 e$ B' _8 e- e7 J' v 生成的代码片段如下:: Y# ^5 h; _( ^
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; 五、打包2 A/ p p+ T" ^; ?- U0 X4 Q
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。. d/ G6 o5 V, N* E/ s$ N; T
六、发布& Z0 V! \: R4 @& [" p3 G. v
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
5 V- a4 u, P: \
# b3 j. S& n* |/ A" _8 u$ m
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~" r0 a. s2 E; n+ @9 P8 W5 Y5 h+ o2 ^
7 H. N5 F7 U- f七、结语$ L; M9 _9 m' o
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |