一、前言
k/ j3 U* q' U 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。( z* @; @( P! [7 o( ^
二、环境准备 " _* s- x1 O* Q
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g3 S9 O& |+ h7 |9 V4 x M2 X
三、开发者账号申请
8 b% p2 s3 r7 Q, B) R 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
% m* p0 [& K7 m+ g. ?/ X: | 1.注册并登录 Azure DevOps 。: J( S3 U; o& Q/ g( |
2.选择或者创建一个组织(new organization)。
& R0 i7 |* y0 V! o 3.在该组织下创建一个项目(new project)。( p1 Y) E( d5 j8 I4 Q
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
6 ~+ Y5 G( l+ M9 J/ S+ \
7 J7 a0 j. G: k9 d E! f/ o: T 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
, x1 @0 U4 y. o2 Z1 |
# B; K" N6 E9 X3 L, v/ r1 d. C
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
* `6 c7 O9 T; p% r 三、项目搭建
, p$ j q K( o% A 1、项目初始化 & A" S" a4 E& V& O
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
?' ~2 _5 J, D' \+ M
2 t& q8 k3 i( s$ Y! K0 n$ u 2、项目改造
' m" g A: r$ w' U+ l 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:* m3 Z5 q& O) j7 V0 t: m8 U
1.将package.json改造成以下模样:; D; N. H1 t* e* r
{
"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包会失败。$ q+ h" c% M ?$ `8 A" V8 b
3、编码
& }$ Y- f9 F1 |) n 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:# S3 a j4 M0 B+ f V: H9 m
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
5 b/ s: O% g. F i 四、调试
8 l8 c: L& u/ q Q* q2 |* }6 Q 单纯的开发代码片段的话测试和调试都非常简单:7 U4 T$ f! n, r \( j& a, i
首先先自定义全局的code snippet。( v% X% K4 T$ L( w
& p- N2 J6 C5 x( D4 ] u8 i
选择新建全局代码片段文件。
4 k" D1 _! ?1 y; W3 R3 n, z
* d, L" o$ D" y4 H. }1 ~% G' X v
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
% ]* W/ i/ N+ Z
# L/ a9 L' _, v0 W, ~# C) o
command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。) d ~% ?3 Q: K
3 C4 a: s& D7 E( e7 V! q5 s
生成的代码片段如下:
* l0 ]& ~' M4 j 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;五、打包 : I1 s* l) E/ v
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。7 z) z. D [4 J
六、发布 $ n) A6 w7 p4 j' o/ c
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!( H) o5 e! l3 x& A2 k X
0 n! x; @. T) l+ W! C
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
1 T/ U/ ~1 _6 ?# j; O; ?6 Q" l
/ s$ _/ y! f6 i5 u
七、结语 ( f6 N: h# P, J8 g; h. z$ c/ V
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。