一、前言
* S- J1 F) [- [ 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
9 N, G1 ~) X- @5 d7 u二、环境准备
6 [$ ]3 W; S6 p5 d0 ~0 V- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
6 b* P2 h& l. w" T) ~! Q 三、开发者账号申请* k" m5 g: k" |1 C- a! a, H
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。# x# l# m# W! r( t3 Q
1.注册并登录 Azure DevOps。
d( R( Z! H/ D; W+ m2.选择或者创建一个组织(new organization)。
3 ~. Y, R% U( y" O3.在该组织下创建一个项目(new project)。
, h% _8 w) S5 r# W8 m 以上三步都是为了获取开发者(publisher)的token,获取token如下图:7 N, [3 s( P$ r1 X9 E; ]" i9 Y
S( N7 z1 }0 V, y8 |8 x; [
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。# g$ p) a, U$ O! M. s+ |
. o+ `7 W8 Y" l% p
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。- l9 v. ~- ~ y' }7 g) e* S
三、项目搭建
5 @$ u0 f+ _+ ?( P8 A- V, G& p2 Y1、项目初始化
" h: y* x9 j, L3 }' G( L4 u: E5 u- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
% x/ ^( Z6 p* r) m7 @: S$ o
2 C. Y, d$ n7 u; I4 @( n2、项目改造
; w, i* s$ T! h- |3 ` 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
( M6 n: z. n0 @% m" g, D1.将package.json改造成以下模样:; g/ I* K/ z6 h0 u$ Z) B6 _( I7 q
{
"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包会失败。: c6 Z( w$ ~' f% j9 k
3、编码6 G$ I( z8 N8 b9 M- i/ h P
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:+ x& P+ n+ S. Y" c
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。0 R! I# |' [8 `5 [
四、调试4 \0 w' C) \; C! {3 A
单纯的开发代码片段的话测试和调试都非常简单:! H5 J1 q; V2 X, B6 C
- 首先先自定义全局的code snippet。
& m4 b! t7 o7 m- x$ P
* N( ]. f0 m% |. i6 i' V- 选择新建全局代码片段文件。- P3 Z+ U7 X9 c+ u# ]* L0 G4 ^
/ ?$ u9 M6 r( r/ Q; n8 n
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
0 Z' k0 H* }' O* i4 @7 |
) r0 C9 _* m1 b' ~
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。2 u7 G' d) {& |# j
0 @, ?, u1 O0 u1 l 生成的代码片段如下:; e2 J/ Z/ T. p1 `& q3 U) m7 m3 p& r
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; 五、打包
# Z) _: a) E6 D' {/ ~1 e 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。! }1 |7 i' f1 k, ~* p$ I
六、发布
8 U$ ]2 D* e1 o2 t0 Z2 ^/ q5 s 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!) B+ I1 m: L+ H9 r0 `2 V- X' y
' d$ U& q: q0 A, J' E 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
8 @+ \/ H: ^ d& S4 k8 \, Y
+ I! I3 {( J) ?, b七、结语/ O# W* ~% q/ M9 C ]! u3 \
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |