一、前言
2 ] v* D; Y. f 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。 M. n# T0 ]6 r' l% I/ z0 ~0 O o% V
二、环境准备
2 m3 J+ S( y9 Y( K$ V7 B( @- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g& a- l% S+ U9 U( H c0 ~
三、开发者账号申请 b% b8 ]2 I- F! S% j) t1 y6 b( B
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
% i$ i* t+ O. n* s, Q# D6 [( D1.注册并登录 Azure DevOps。) E9 `6 s8 G4 b# s7 j h" S) z
2.选择或者创建一个组织(new organization)。
) S! h# O/ n+ Y9 j) I0 K3.在该组织下创建一个项目(new project)。
' ~# C% Q3 o( y7 w& @& s: G+ y/ k 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
- K0 q4 P# A. Q, p& [6 e
- G4 J! q3 J' S- @$ w4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
2 E2 K$ Y$ q* h6 C2 J2 v
) D% j* o( P7 c1 }0 o* g* ?+ r5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。0 S- c3 s; g$ J2 l) b/ _5 L2 l
三、项目搭建
% u0 q- O: r/ o7 O8 _1、项目初始化
& x# p% E4 ~6 X4 n' v6 ^ a) M5 D- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
~0 s: q$ I* `
9 j. U, ~+ p9 }' y' W2、项目改造( t) I: \6 k: q2 I9 y
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:" S2 ~! d9 q2 Y1 ^) r8 y4 x9 M/ `5 v
1.将package.json改造成以下模样:, {: l8 [# C# o& f3 Z% N
{
"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 Q6 D7 w. O) H) ?3 B
3、编码/ V7 @6 k* U& `
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
* V9 n W/ M$ | y! A% R& [9 P{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。4 [7 ~/ N% ]" C
四、调试
0 e1 v K9 O5 w2 c6 Q 单纯的开发代码片段的话测试和调试都非常简单:7 |3 R" r' W H3 f
- 首先先自定义全局的code snippet。
3 E' b5 c$ s( K* H H
. ?$ `5 \ Q6 B: E. f# C
- 选择新建全局代码片段文件。
# |5 P+ w& F8 T' A# q
6 n, b9 m, `7 v6 b9 b% _7 l3 L
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。" q4 g$ ?7 u: z/ X1 G; P
7 V! _; O: J: v6 ^6 H7 o' M# C" j2 L" Z
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
; \& V" w' [0 [# h" o
& @5 h2 g O. I3 q 生成的代码片段如下:
* W! Z9 V' F* W! F8 k: S/ eimport 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; 五、打包2 m' x$ V% I* p# j; a$ u* ]/ }, ]
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
7 V+ M# A! s+ q; C* R9 A: Q2 b六、发布9 M2 Y$ `0 F* c+ @) t
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!/ `1 t1 d- ]$ `/ v
' f9 W+ P) P: `- R' J8 q* R 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~# R+ z* k7 ^9 d) o
: `8 x7 U* E4 |, P' i$ p) o3 s七、结语+ _ V2 I5 }5 D
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |