一、前言
/ |! p# D0 \& n$ x1 C! S 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
/ k# N1 M& u3 {) z; H8 m二、环境准备
3 L P# o$ `* I/ k! M+ S7 g- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
1 k5 l4 [( m3 T- y# H 三、开发者账号申请4 G: q4 M' u7 i' A$ \2 y
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
h) T1 x) }8 D$ L8 ?/ P9 E( a1.注册并登录 Azure DevOps。
$ [; w8 ]' N, ?$ h w+ L2.选择或者创建一个组织(new organization)。
+ K2 y2 `2 l' S% D" r8 A2 w3.在该组织下创建一个项目(new project)。
# h( M3 l4 N' f 以上三步都是为了获取开发者(publisher)的token,获取token如下图:+ ]* t* c9 }, x8 b4 J _
% ^% x) u6 y. q0 b* l. |
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。- A0 k) S6 b3 }7 i1 R! g
# y7 ?7 t2 ]- u$ P8 p! T, U( H
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
* ?+ B6 u( q o9 z, w三、项目搭建5 Q' P! j J$ M9 H2 {" I, E
1、项目初始化( D; i' [5 v$ g# V% B* g, c
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。& |2 r; q1 O5 G, ?% b$ N; Z8 }
: y; w8 W: h, q
2、项目改造, g& v* k+ h3 B
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
5 s, g3 k; v" Y8 W6 o1.将package.json改造成以下模样:' t4 L- Y3 p! L8 \4 f, I
{
"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包会失败。
/ R8 [1 K M* ^, d0 k7 }) k5 Q3、编码1 t o/ g* y& |% y: q/ ~. `6 ~
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:8 R- Z: Z$ z( ^6 U6 [# 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
0 x. k8 m# {; b四、调试) h+ N7 w t2 i8 M( ~
单纯的开发代码片段的话测试和调试都非常简单:
6 S& _& W! H$ j0 e: }3 H- 首先先自定义全局的code snippet。1 J, y# K' r! k M4 n
8 N- Y5 _; i& _- V
- 选择新建全局代码片段文件。( {4 z/ y7 x/ D7 _3 }
+ }6 U& j5 q- a
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。* y `0 @* { f; t* B
6 y8 U% S4 V, L( S6 c$ b h( \( n
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。2 t9 n8 h4 n* W; U2 w, P
0 A3 f- T( ]0 i6 T# l
生成的代码片段如下:! m$ h5 V. \5 E
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 z" p& [! d1 j* r" N: R' J
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: G$ b2 k Z, h1 _) o: l
六、发布
/ @ B6 i4 K+ k9 [ 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!" N0 r5 x; j4 C# ~9 j3 @! {; A
- ]7 l/ k1 S( J4 A. j0 Q w4 b
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~# a5 I5 A2 u2 I, p0 S9 ^
; M5 X3 k, T( P
七、结语
% @2 g6 B5 R/ L3 T$ [, J0 B. j8 J, q vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |