一、前言
8 s( N3 B+ {$ H! o5 { 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
8 v* a( T' X* u# ?! p- v二、环境准备
2 R$ _( i7 F' H: E5 m& R4 }- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g; z. a p ~5 z! c1 t( r' W# F$ q
三、开发者账号申请$ g. k+ |9 f0 P) M
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
2 O) }/ d6 ~% D- q4 ]1.注册并登录 Azure DevOps。2 X" w7 U8 {, Y; m6 e7 V
2.选择或者创建一个组织(new organization)。7 C6 I4 y, o8 H/ {% P
3.在该组织下创建一个项目(new project)。, W6 F& I! ?; ^; o/ u n, P: \
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
- j/ Z4 z7 f& w* E% V" J3 P& c
! e$ V0 b! ]% W+ h4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。3 g' } u1 {5 c) H7 c) q
) w7 u m3 N& m& D# a2 Z2 [4 ]5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。+ j# @! G5 v7 O- g
三、项目搭建
d- o. l$ o! J0 q: S1、项目初始化
8 J: `/ C6 L6 i0 b- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
. X4 [8 p/ z! a3 I/ V0 Z3 y
( q. a" M; ~3 w6 Z" C2、项目改造4 B$ i1 \+ v' \$ \' K+ b
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:8 m5 l% u& f+ Q" [( V \
1.将package.json改造成以下模样:
2 z9 ^( q# ?4 P) 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包会失败。; X- w* d- G( J6 A, I, I
3、编码
" Q5 Q9 O& g* f. L 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:) |2 n) \: e: [1 ^
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
2 O- D0 v9 _1 G0 a% K+ g四、调试- B/ B7 h9 ?( k, Q8 n; m
单纯的开发代码片段的话测试和调试都非常简单:
' J" ?, a8 m# e8 q- 首先先自定义全局的code snippet。5 V& P. K: [2 e/ g" y1 [ W
9 o+ ~$ h: y2 N
- 选择新建全局代码片段文件。$ M( ?% Z! [7 Z7 a
1 d E% E8 ]3 B q7 `9 S4 X
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。9 |/ q; J2 W) i' K2 B, n. B$ _1 _
6 j. S+ A' Z9 _0 F
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
]# F# E0 U9 s/ T/ x; ~. O
! _/ P6 Y6 c7 b- k5 j& b 生成的代码片段如下:# z S' O$ V1 z. b+ O! ]) q4 I
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; 五、打包6 B# d& N0 J9 U3 C8 ^7 b) ~+ b9 t$ q- q
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。( b3 B0 o7 x' K) {4 Y
六、发布3 [. b( g" z( t& n
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!& R; j4 m3 K! O; V
3 y( A2 ]8 x& }- }) d 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
4 n+ B3 s) ], R: q
! _. E6 L$ Y3 I& b7 z七、结语: J9 @7 m/ @* V) @% h: n* R
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |