一、前言9 T& d, Q0 S ^2 T1 B) `
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。+ l1 A$ ?5 V6 R7 Y+ L
二、环境准备* _7 |" P6 y' d- d1 M
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g& [& Z1 C+ [, ]7 M- ?! [
三、开发者账号申请. {# V- I+ `! q/ o7 r4 v- Q$ J# f
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
2 A4 D4 W* n- p9 ?. @( D1.注册并登录 Azure DevOps。
" w2 i0 k& N* Q2 t1 ~7 U. {2.选择或者创建一个组织(new organization)。
/ |3 m! p0 d& B3.在该组织下创建一个项目(new project)。
. v9 t2 l& C$ t# l4 t 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
9 H1 E6 b9 ]& `2 f# Y1 b" J& J5 v
9 N$ i4 e9 k8 q# t
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
9 @: e0 m9 x7 a# Q4 o0 Q) P
; ?- h# M$ q* o+ u
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。: m0 p( V6 y9 p- A
三、项目搭建! a- k' V z9 Y1 s" _: ?
1、项目初始化# T+ |+ a3 X) a9 J
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。% H. D) r4 J" i
$ q5 A& _! Z1 N) a% d% n
2、项目改造
. r8 y/ i0 R: x( c 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
- \; z5 z0 u, h7 K3 h( |. r- e1.将package.json改造成以下模样:; U) U* ^6 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包会失败。
, L% i5 Y/ m0 d* h6 [3、编码: Q5 i) U% g) q, j, m& p) g9 U
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:0 U6 B8 u, E0 l; P/ E, ^/ g3 X8 g1 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
9 Z7 j9 q& o* L- x四、调试. R( _/ n& f2 B) P3 h
单纯的开发代码片段的话测试和调试都非常简单:6 b; L# Y' p4 w, N
- 首先先自定义全局的code snippet。
- W z4 ~, i( j4 v. [
$ E) Z: ^+ _ I- 选择新建全局代码片段文件。
+ q+ U2 A* F4 C2 `
& X; g0 M* W7 a0 ~3 D' a
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
0 _8 n$ ^1 n {' a3 D4 \# X" m' h0 V
! z; N5 ^* C. `& _+ j7 U
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。 |. _' a$ n4 T5 `, f
3 r0 s: U( C0 e5 @$ P# j, V 生成的代码片段如下:
2 {; b: S" P, l9 O5 z9 {3 Iimport 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; 五、打包 ?0 K' ^' Q, Y$ C
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。9 n9 v2 ^ H9 P: j Q. E9 Z
六、发布! v" E$ j* x; |7 w ]2 F5 j5 S
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
3 i k! `$ c" d7 ^% \
% ]9 L y% q% w4 X
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~* y5 Z8 g" c2 t, S: B5 U
$ ]4 e) {0 N- M2 A$ n
七、结语
* a& h" Y! ^' \ vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |