一、前言
& s: I1 `8 w: t" h 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。3 S i/ N+ I' a) W' t- g
二、环境准备: h7 N- P& U9 O( `9 _5 _6 ]. y P- j
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
3 P2 r' m) f( l7 P% p( A; E9 @ 三、开发者账号申请
0 V/ f) z1 r( W% a3 Z! y 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。4 W; ?5 c/ B: ^) B5 ]6 i+ K
1.注册并登录 Azure DevOps。
/ D1 w! z# P% m) A: Q9 \2.选择或者创建一个组织(new organization)。
, o+ U' q/ @) C3.在该组织下创建一个项目(new project)。
" V( ]( Y3 k% x2 r0 Z: c6 T# c 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
$ Y' Y# P% p6 I2 y
' S6 W& ]) j: m+ q5 s1 j
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。& f- k+ u* H4 V: l
4 f! D# ^ G" F# H9 k5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。1 \% g* N+ u8 K
三、项目搭建$ S1 ]& ` @7 |$ T1 i) c
1、项目初始化- c8 b; p( D1 |5 W6 i# E7 }
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
8 I$ E* K+ P% @, k
& S( q& ?. I, [" L3 V0 l2 U# E
2、项目改造
8 Q2 P( \7 K4 F 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
: z: z0 {, x% f$ k3 w: b1.将package.json改造成以下模样:
: ~& B4 @7 A$ G& j1 S, m{
"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包会失败。; Y. i2 ]6 i5 P8 Z- I
3、编码3 c- I3 |' `) t) [ Y
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
; U- A0 G; c( 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。; z# m+ j7 `! S& ^" J; h, V: s n6 o
四、调试3 J1 r1 e. }' G6 |
单纯的开发代码片段的话测试和调试都非常简单:% `+ h/ _* p% B: @) C
- 首先先自定义全局的code snippet。
5 P: W; H2 v( z
2 L$ L! a- x$ J/ t0 E3 ^; {$ M- 选择新建全局代码片段文件。0 a, B2 B" z2 R4 `- @
+ A/ \ K% w: `, w% O8 n
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
; Z- K# f0 X" R9 H' g6 S
T! ?8 O! w! y/ u) `, }- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
: R9 K; T2 K( a% R" Y. V
) \% e4 |) C! p! A/ e( p 生成的代码片段如下:
# n5 @2 x2 Y& K# [- K$ v' ~2 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; 五、打包" d3 o; K7 R# J0 ]! M" i
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。7 p& R4 ~+ `% v2 ~9 ~
六、发布
0 y$ G( W6 }4 V0 U/ S1 {& \: K) V 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
0 V/ e- [3 l; ?3 Z' a$ N
/ C) x8 ?! R! V. t: P3 F: F
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~! A! \5 I$ F6 y
. W6 @- {" ?4 {0 e! P, G2 F七、结语/ A8 f1 Y) y9 z e: p+ o
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |