一、前言5 p4 G g# \( @
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
@4 G s* i8 \# N5 y# O: |1 }- H5 Q1 i二、环境准备& w, n" E+ H( A5 Y
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
' w" [, X5 T( W; q 三、开发者账号申请
7 O2 Y L3 B$ M h0 I4 N 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。1 G: e/ U: D# U9 Z
1.注册并登录 Azure DevOps。/ F9 t+ S5 A( O& h. z
2.选择或者创建一个组织(new organization)。1 F8 l( O' B7 M
3.在该组织下创建一个项目(new project)。 n" t- E8 t) `0 i$ n+ e
以上三步都是为了获取开发者(publisher)的token,获取token如下图:4 i6 h/ g- |; v* {9 |& E+ g/ x
$ m" _, \' }6 B# a8 T/ b" ^2 L) {$ P$ N
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
# Q# [8 g* n+ i8 E
* {9 y* T {. k# X) c5 S% g
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
! d+ C, |- U1 s8 {0 w4 f2 Q c9 }三、项目搭建5 J# v7 m) S% _4 ]/ p1 @1 k' G0 P+ g% {
1、项目初始化
0 `' R. A& N2 Y4 V- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
: T x2 Z; @ U
2 j! p9 | Z2 C9 X2、项目改造# j; u$ B! [8 H* t" W7 r
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:" A& G' T7 @; b$ F
1.将package.json改造成以下模样:
* D9 s* F- e8 g* T- l$ G( J% P' ~{
"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包会失败。 a# L4 Q# j$ K& f: k
3、编码6 Q+ V ?0 R' m1 C2 I$ y! \1 l ]
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
% g$ n# b# e0 I3 ]) e0 |1 t9 v" 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
: ~! p. `) \% o% B& E, d$ g2 z四、调试
" P% e# m3 H! N9 }2 v; n$ F0 } 单纯的开发代码片段的话测试和调试都非常简单:9 H8 e2 H7 [4 C# _
- 首先先自定义全局的code snippet。
8 S9 q' k* y/ |' G$ a& o
$ k- |- o5 Y( ^
- 选择新建全局代码片段文件。8 A4 u$ `! U) [( f' I
/ s# o- Y9 q) u# g5 {3 c
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。% |) i3 y% K8 Q; z. Q: J# q
: |+ B* L- D7 ]4 f7 i8 H; D3 |2 e
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。( d) H& ?; N& ^! T
u9 S% e9 x0 ?1 g) S+ m4 F 生成的代码片段如下:
# u8 C7 ?' m% R4 O6 yimport 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; 五、打包$ e' X6 H8 p9 I( _* M4 z- _1 ]# w `
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。$ I j: y: z" \# _8 h. @' x I
六、发布1 ^5 _& x) w. U; y
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!3 \3 v' y6 k9 w4 r. N, ^& I
/ D. b( C/ h$ n8 W4 l
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~- ` n) a; h7 \7 H, G; D" {, p6 ?/ H2 t
( h0 m+ b/ |9 w0 k* s: N0 D" g- ~* r$ n
七、结语
* m+ \1 `: c- K+ m L6 p vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |