一、前言
* L+ D& U' ^4 Y( |/ ^ 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
. f8 B6 l1 C/ @: h& h# K2 L' z9 U+ Q二、环境准备
9 ^/ K' q& X( \7 a! A( ?- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g. M; n5 v3 ?0 |! e! H& ~6 \/ j
三、开发者账号申请$ h" Q2 D3 M( A
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
- [2 B3 p4 P) T1.注册并登录 Azure DevOps。2 e* n# A3 z/ ]: y, L
2.选择或者创建一个组织(new organization)。8 J9 Q: P( S# h. H$ N
3.在该组织下创建一个项目(new project)。
% F& i+ V0 L, C' B u9 x Y2 e 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
: p* O/ j3 x1 l2 u* ~6 g4 q
; u: c5 H. E8 y4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。8 S0 m/ j1 J* F# ~8 O3 o
5 C2 a. q! U* t1 ?- E
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。8 g2 A4 ~9 h5 y0 Q4 K k9 g
三、项目搭建
/ r" T0 ~8 [4 u X2 @/ G# a! R1、项目初始化
" M8 a' B& t# D/ g- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
7 m/ p' O0 X+ k/ q) Q% f
% x, E/ Q, S9 l8 F1 Q
2、项目改造$ t* K- q. L1 D+ b* I7 r
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:% {0 W6 b2 Y9 G1 t6 m" R7 l
1.将package.json改造成以下模样:) e% h; ^$ a$ n$ x4 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包会失败。
; u' h% K4 t; x- N1 c! @! j3、编码
9 K; z3 j0 x% K/ F& D" p# Y 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
4 n9 ^$ [' G6 E$ U/ ?{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
& s' o F$ F! v1 |0 d5 j; G* T2 H四、调试
, q; b# C4 ], i; n) f2 W 单纯的开发代码片段的话测试和调试都非常简单:
* d6 K Z, S2 ?8 W1 q9 {" l; j7 `- 首先先自定义全局的code snippet。
8 F+ l! R* V" b& Y
: {) [7 @. i" t% D- 选择新建全局代码片段文件。
) M" v( J4 T$ T) k& u1 W+ U8 p& j5 w; k
7 c8 h- {% O \% v3 d1 x- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
z8 M# Q8 h" l5 Q
0 x- C! g7 U; R. \( X. q4 |! D/ N- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
* s+ ~( Z% h; ~
' \7 V# j O! O% D1 i/ X: z# M( l
生成的代码片段如下:
- U. y8 A A" i$ j# B7 Mimport 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; 五、打包- I; C$ _) H1 P/ M7 u4 A- {
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
; T3 I& ^0 _" B$ o: W六、发布9 K% f9 E% X b; C* h* z
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!# M% X. S1 n( ^1 p4 d8 M7 H
4 r8 o% c# y( K
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
- H* K3 Z4 G S$ W8 V" p
9 ~+ T5 S, X& U# B3 I, k
七、结语
- L" l! O1 d X+ [, f6 m vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |