一、前言, c& T6 l, [ l: W
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。6 K9 ~9 h C8 N+ }/ ?7 b: A
二、环境准备+ [: Y( k2 {; }4 |, o2 _; A' x
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
/ l+ U) Z/ ~8 d" n 三、开发者账号申请& \7 f/ Y4 W. N. k
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。$ D9 w! [/ q* J& D5 y
1.注册并登录 Azure DevOps。( x4 t ?" ~# L+ o5 o) @( |: H
2.选择或者创建一个组织(new organization)。
' Y% f5 `# a0 Q: g3.在该组织下创建一个项目(new project)。
, d6 ~! i. W5 i% O7 D k( { 以上三步都是为了获取开发者(publisher)的token,获取token如下图:" Z: J4 ~* b5 ]0 r5 o: r7 i' L
9 E c$ u4 C& n6 V( {
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
( H7 s* r- @7 l, M. [
) U3 l: s% c7 j$ z- V1 p2 {
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
+ f/ ~/ Q! @# Z1 U1 B( o% N三、项目搭建0 ^" A3 L8 N4 f5 i6 |8 I
1、项目初始化
" Q+ z" Y6 I z- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
" \) O- U( [- f
3 ?8 s" ]+ Q0 d7 X
2、项目改造, ?* W# p- a1 d- j5 ~4 Q( T
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
" R0 O1 o; a8 }& o8 P1.将package.json改造成以下模样:; n3 {9 [/ L, P) i; P
{
"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包会失败。
- H3 J7 [$ Z6 X4 r9 z4 j% {3、编码0 v# [; R8 D6 O$ m+ t: z7 ~
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:: P& W+ w; C* u ~+ M1 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。# ?& J. y4 p: o4 A ^
四、调试7 U1 Z5 G9 G" E9 u E
单纯的开发代码片段的话测试和调试都非常简单:4 O4 ?2 c7 x+ S5 `
- 首先先自定义全局的code snippet。# c/ l7 { J5 j5 h0 N. Y6 {( V
1 M2 P$ j7 q# J& k* J# X& G& T
- 选择新建全局代码片段文件。' N& ?, E7 m- O. i# O
1 w! z1 A ^! V/ V' a
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。1 \$ b- [ x H$ d% a
( I, X3 k [* G& T* n3 R
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。9 w0 C* M; z8 Z$ K5 Y d
7 [3 u: `" S/ z2 o6 f 生成的代码片段如下:/ i# F# K8 Q9 `& @+ B- e8 E6 y
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; 五、打包8 y- t2 J2 [/ n" _5 Y ]" c7 Q+ o
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
! z8 Y0 C3 c: F5 _六、发布
- u# U9 N, H& H- _+ P7 L 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
g% s! @9 [- H0 l1 K
% _6 {7 ~* P8 @+ O) \1 }% H1 Q2 ~ 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~/ Y6 K& X, J( o& a1 q% f5 |% w# U
# _: M0 X8 v. {; G# F7 m7 {; n
七、结语
8 l. ?: c& z3 o* O3 {/ g- U3 H vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |