一、前言
7 e: b$ o0 i* o8 C# k 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
( R8 z( K# I0 n二、环境准备+ Y- g# i) x( {, A
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
6 R0 \' r" O: y5 L# ` M/ ]0 s" L 三、开发者账号申请
; H, I% |* }& m( j. d1 e$ C& Y 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。& W6 H8 T% e% J$ t( C- o
1.注册并登录 Azure DevOps。+ Y3 Q3 D8 O6 G
2.选择或者创建一个组织(new organization)。1 e1 c7 R1 V/ Z% p) a0 f
3.在该组织下创建一个项目(new project)。
& I1 i1 d o$ X4 q 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
# g" I4 f8 \/ j2 S
' m: M. q1 J2 h5 ^4 N. l4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
' g9 T) { J- f' P- T0 o2 A
9 D% y) R/ G3 j1 U6 H/ k; B5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
% J4 ~7 S7 A9 M& V0 f ~三、项目搭建
g r' J/ F$ r3 _/ ^* r6 H1、项目初始化
* l$ h% t+ o6 U0 }( K$ x8 h3 s- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。/ L; v" Z3 c( X6 }9 Y
# U7 B9 U' K, s2 r2、项目改造
9 w0 j& ^9 p! _, R; U1 V6 r8 T 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
% A2 \& ^. i, x: p4 H( c9 z1.将package.json改造成以下模样:
* H7 W$ q3 O: t" P- j{
"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包会失败。8 `0 ~5 K# ?% I* K( z* T5 X" T B
3、编码
! P' n0 A8 i2 [; u$ W 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:7 r: ] }1 n$ E
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。( L* }! {9 r8 q# _' m
四、调试9 n; L4 m4 h; V
单纯的开发代码片段的话测试和调试都非常简单:
' g9 {* x* N: c m- 首先先自定义全局的code snippet。! c+ a+ o* h7 q' S* c. w
. d1 h" E F+ f
- 选择新建全局代码片段文件。6 @/ H/ ?+ ]* y- ^6 _9 T6 u
8 Y( ~" i0 K( V, e$ o" \+ \- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。2 {0 e8 B# c I, _
0 B5 D3 }1 V2 q$ k& l- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
/ x j7 h; K. o3 _
* O% b( s6 F8 J
生成的代码片段如下:8 T8 \( E- U* w z1 H; ~; F6 l
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; 五、打包
5 ?! }' X: Q" H" v% e% U2 u& L 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。* A: E. c4 u! T
六、发布+ T" y- j) r7 ]1 q; C2 z0 U
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
0 g- e# g/ x( M7 s0 f
, O6 q) h$ V, t
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~3 P3 R# s" W# m
|0 l; f' e6 u1 O七、结语9 V8 Z; Z5 o$ Y% y/ y6 k0 i
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |