一、前言
5 S+ k; g4 l2 o$ L9 U# F' F$ O 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。3 [0 e0 ]: Q/ m) k q& G
二、环境准备
% Q( e9 h( D4 A$ l- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
- e% `7 d9 x$ L, V, G3 {' t 三、开发者账号申请$ |( b/ v u8 q8 A0 Z/ \
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
. w' c: j) x; _3 B3 A8 L# x6 a- M9 G; q1.注册并登录 Azure DevOps。
9 L% [* f4 ]7 n& J5 A4 n1 \% D2.选择或者创建一个组织(new organization)。3 `1 G" J6 r( }$ R3 q0 U+ o
3.在该组织下创建一个项目(new project)。
1 U! w" S3 g2 p- g, ]& p 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
+ ^ {$ I5 f$ L% |. P5 d4 y
2 K& f' r0 t+ }
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
( ~( L2 b$ k6 ~* H8 A& f! V
$ M+ V. A& d; g9 X# ?0 t" F
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
7 V9 ?& C* P% L, ^三、项目搭建" j( Y4 s! y Q7 U+ U, g# {
1、项目初始化
1 d( ?8 z; f! R+ S, n- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
r5 F0 `6 W1 D% r% T- {8 d9 ?
3 M4 a* I/ s) v! w2、项目改造9 _! W( V) e( O* Y( g# S" j+ R
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:# R Z! c8 v2 n; Y* c. P, g0 o
1.将package.json改造成以下模样:; K& F0 z9 B5 F1 x$ o7 X, l* X
{
"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包会失败。
. b @5 C1 e5 C* U# I3 y" O1 V3、编码
) z: @9 ^( g3 c; y2 ~4 W 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
, h; A) F( B' j& g+ E{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。" H- g1 u* `: C" Y" v& l9 L
四、调试* h* K+ k- a% p9 X
单纯的开发代码片段的话测试和调试都非常简单:- o( @4 n- D& F% o2 y! O0 h4 C2 Z
- 首先先自定义全局的code snippet。# _3 C' Y- y' A
3 q5 D+ v' t4 r) T6 H5 f4 W8 A0 [
- 选择新建全局代码片段文件。
+ M- n8 [) E/ m4 |3 y$ U6 J- B5 |
* r5 V6 t+ h# y& \6 { s, {- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
0 ?9 ~5 t, ]9 Y% _$ O
# Z7 d# n/ {7 x# J: `3 q9 Y
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
+ H/ q' F- U' B3 S
; ?; {/ l9 J* X, @4 V, p+ R 生成的代码片段如下:
& _& g! }5 L9 R% t. C% 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; 五、打包' Q2 H2 F( z$ F& e( h$ x
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
! b( p3 H; v# s# U3 m六、发布
1 \# }: q z. F 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!" |9 |2 I: x& r# L& a6 P/ \( o6 F
" B/ I: v0 d9 ^; w 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~2 ]4 w( K6 d4 A2 Z
$ L* r1 P+ g- E) V: y! R0 O3 Y
七、结语
! `7 j/ v1 v* L6 x3 ~9 d vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |