一、前言 : i: _/ U; J- \
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
3 X# ^: v- F+ v' B! c# g$ s$ k 二、环境准备 $ v' Y4 J5 c" P
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g; T8 [% p- H: I! A
三、开发者账号申请 / i5 e5 C# P m0 {* [% `/ f% Z! H
点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
+ o' e$ f0 s8 [. V, |+ O 1.注册并登录 Azure DevOps 。
* O7 O4 _2 V2 x! ]6 c3 E9 H9 j 2.选择或者创建一个组织(new organization)。2 a, b# C. ~# k( g+ M
3.在该组织下创建一个项目(new project)。
+ w1 y) A/ { _* H1 Q1 c9 } 以上三步都是为了获取开发者(publisher)的token,获取token如下图:# a( O8 x# p$ }( ^: b, Q8 h
* z/ z0 V- _2 j# X! k
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。6 D! v$ z0 ^4 j2 O+ h
5 u6 L( P0 z7 K' V/ o
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。0 a! f+ o- M- |- X; X: x
三、项目搭建
' X @5 r R8 m& K- n4 O 1、项目初始化
/ r) u! g' T% \3 g 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。- t, f |" `1 k+ d1 x1 F
$ f& b' @( `/ W* X, [( {! }
2、项目改造 ! @8 T$ J4 ^, f3 a" V- ]* ]
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:( Q% W2 J: S+ f0 Z6 s; E$ y4 M I4 F
1.将package.json改造成以下模样:
4 W2 p$ B. w: X* g+ k; A {
"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包会失败。# T! L/ d3 d8 @: ^- B+ w( S/ `
3、编码
' O/ I' p& B% x( q3 ^ 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:. h/ w! `9 y1 t& ]& b9 t, r$ a' W
{
"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 [2 L: w) X0 g9 T3 u. K
四、调试
% g) k4 G& i. B2 `% h 单纯的开发代码片段的话测试和调试都非常简单:
! x9 P7 a \7 n4 ~) X# _2 r6 u 首先先自定义全局的code snippet。7 r* j, s& P5 a3 R3 P
. H4 K Z# v" R+ `9 I9 W 选择新建全局代码片段文件。$ }: Q+ _; `5 I. Y S
% K8 ?+ X" @: `; y0 j1 f ]: Q, ~) t* U
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。9 P8 I7 H8 `# E4 `8 L% h
" H$ i# Y5 W2 K( z. P; z
command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。8 M$ ~$ {" N# G* p8 s
' o9 o( l$ g+ S, g6 ^! [2 o" ]# H" G0 i
生成的代码片段如下:% G& t. x2 _5 q' ~4 k- a
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;
五、打包
6 [; m/ E# `' \$ k7 k 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
- Y& G" Q+ x0 k; @ 六、发布 4 U; j0 h8 l( G( q% k* u: v B) Y7 y3 w
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
% }; `7 h$ f" E0 V5 c
* T8 Z- s+ |# m1 W8 d, s 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~0 T8 r+ F4 a0 N$ w% p
5 {. t3 l- n3 |9 r7 L
七、结语
. F2 D+ c1 s2 q2 F g vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。