一、前言) r0 j: ~4 J. d6 V
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
# q" M, y: c+ |9 r6 ?0 x0 W2 c8 }二、环境准备* `. L2 k; M3 A1 n2 G
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
* d9 H: r& `# R4 [3 k 三、开发者账号申请6 H8 C- G' B' W4 z0 c
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
7 V/ t7 R6 v3 [1.注册并登录 Azure DevOps。; ~% P: h h' p! E5 b
2.选择或者创建一个组织(new organization)。$ c7 C4 a- n; v: \
3.在该组织下创建一个项目(new project)。
# j% X: |" r' u( @) S* n 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
% s A; o6 q! w
, V) @/ ]% t+ k& ?* A4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。3 I. _5 \/ j4 I/ |) N& P
$ M$ ?, x2 W6 l* t5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
) P+ n7 m1 ?2 m+ ]三、项目搭建1 i$ e* W: a! e" E0 v" g4 X/ L% ~1 a
1、项目初始化$ f" P( o$ H( n3 ?2 r( q
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。5 y8 l7 t# _1 f. D
4 M0 C9 E( o. e. m' V3 F
2、项目改造
+ ^% X: d8 Z0 u" @ 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:, W5 {" W2 F: w8 {* V5 T
1.将package.json改造成以下模样:
! k5 ~6 c5 P% t+ Z2 Y- g{
"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. G2 v' n: Q3、编码3 B* t W7 C# y
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入: H" T! s9 K( G' |. 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。 D9 C# s/ ?* y' w5 v7 r- A
四、调试1 G1 x' Z5 o+ B1 l
单纯的开发代码片段的话测试和调试都非常简单:; P2 @3 l- {" b* {( b/ F# g' c! G
- 首先先自定义全局的code snippet。
; R, f% l5 F+ z
S* N/ x- t! T) z2 S. T- 选择新建全局代码片段文件。, X) U4 |8 Y; Z# p6 c
& i. C0 Q7 B5 v" H3 W- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
0 Z5 K' l- f% p* B
5 V& G; G5 L X m( z- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。! w) }7 h; w7 b3 r
6 d1 Q* u% j( w2 G* p( P m u/ I0 F7 O
生成的代码片段如下:
+ d0 u3 W6 u/ w+ s. d8 Q( rimport 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; 五、打包
% k; t- `% ~; e0 D 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
' q8 @, b+ F+ K) @六、发布
( |3 b1 Z4 e$ k. y9 I 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!7 V" q5 b* U: f" G3 k U1 z
- X3 c' Y( t5 }, s v9 L 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~6 b4 o) g- m% R' ^& }
; W* G2 S: U+ ?; \$ ]
七、结语/ n2 m7 A, ^: k' W C7 \
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |