一、前言
) s: x$ a2 {1 w% e8 L% M- P 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
" Y0 n" c- I# C M1 D 二、环境准备 # a3 l3 K0 v* c( x/ }
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
. E+ x' ~5 U( O2 @& ` 三、开发者账号申请
; Q' j3 q! Q& W+ e5 n 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
5 a& S0 X& ^' f 1.注册并登录 Azure DevOps 。/ d. x+ u/ I1 E0 p8 K* }3 ]& Y" J" Y# G
2.选择或者创建一个组织(new organization)。
* S) v/ X" h' X! t9 J 3.在该组织下创建一个项目(new project)。
& ^5 M% Z* K! B& M( D0 E 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
/ I2 J+ u5 \' r# g7 m; \" }
% {; _, q; {( B6 G9 L/ F- ]* @ 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。' D# U0 I- _8 M# w4 V+ R
* c% c2 D: R6 H9 Y 5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
: q: p+ x# P$ r$ v- h 三、项目搭建
8 X6 A6 \- t" \4 u* D& O0 Y 1、项目初始化 d5 p& K% i" y2 w- f! e4 V
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
8 o% B% A; j/ u1 {
! s F& [7 o. X& c) M( x 2、项目改造
$ v# P5 {& X, x6 s! T 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
/ a% }5 G' B5 o2 o- E9 @! \ 1.将package.json改造成以下模样:
# Q+ z% N. m+ {( J4 Q- `9 J 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包会失败。
5 ~. J; G$ C% c3 _1 l0 K% m1 F 3、编码
; w0 U+ g, Z# q& T 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
2 O+ R8 f: {7 W4 y' {5 L {
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。' a" |7 D: A0 D1 l1 z; ?( j N
四、调试 5 D1 \( @, z0 ]* Y5 i
单纯的开发代码片段的话测试和调试都非常简单:
0 ^/ _( k9 J/ B8 |9 w$ k 首先先自定义全局的code snippet。* E# ]- Z" a* M0 f7 ~
) N5 F( `0 w0 y# e7 T5 Y 选择新建全局代码片段文件。
5 F. N( [" k: d: E4 F3 H$ r
8 u3 C* i+ I! x4 J w, ~7 ? 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。6 j4 n9 f3 W6 ?: r% o" l5 ?
$ y R" o: b/ @) D1 C command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。( Q1 @- L& O8 }2 F5 m3 w) G2 e/ E( A0 Y
4 q$ P7 }, T9 I+ b. V6 F+ | 生成的代码片段如下:
6 Y ]/ R% S9 [ 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;五、打包
' K: l" G. t% d/ I, H9 Z$ o' O 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
! o. ^& H: t0 {% g/ ^6 z4 q+ D% e 六、发布 $ m% C `) u) c* g" b1 ^
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!' _$ f) l d% y! l' n
2 V a% x/ a$ h( a 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~8 M$ B5 ^0 G, P8 G; u ]; `& k, b
t* P( G m# |6 P; I, y8 U 七、结语 - i0 b( P! Z) g. g! d
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。