一、前言
, O. g) Z; s/ ?" \) f 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
8 _/ w, I |! M( P; w3 b二、环境准备
) d; ?. \, _) c# G$ j6 E- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g& m1 i$ @1 K/ c
三、开发者账号申请
! s7 e7 ~8 L8 s5 k1 E4 r5 m# y9 M 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。; m" N4 I3 M$ \* r3 Z. d
1.注册并登录 Azure DevOps。9 K4 y/ z3 r8 s
2.选择或者创建一个组织(new organization)。
' |/ u. O7 l5 b$ L) ^3.在该组织下创建一个项目(new project)。% Q B# _3 _( i, K) B
以上三步都是为了获取开发者(publisher)的token,获取token如下图:( o* g0 ?$ r( P7 ^
# |' Q. J) Z: e3 R% V% m! \
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。0 e& Y( u8 G2 N/ |0 c: ]1 o6 L* H E
3 X9 L& y+ |; |4 @ t- N+ z% A1 T5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
/ `9 N. X% v1 {三、项目搭建3 o0 ]. w9 H% ?$ |: o
1、项目初始化
, c& M8 @! t8 |- T: Y' }' R1 R- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。" s# ]" j( u, u! T% c7 o, a" k
4 s y7 I* C! A9 _2、项目改造
9 M9 a5 I6 T7 y& C, v. Y: A9 @ 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
; ]5 y& ?! O# z4 v8 K! T1.将package.json改造成以下模样:
9 l$ M! ~8 r* h9 S7 w" J( t{
"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包会失败。
# Q- h9 U' z! c- K$ O3、编码
& C9 @- a U. D 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
0 g) b4 n/ a- `{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
5 p2 F1 w) s) I k. ?' V四、调试
/ H3 ^; \+ _' f; y1 `" L! J/ | 单纯的开发代码片段的话测试和调试都非常简单:+ l |% b$ M5 C8 V% p, ?
- 首先先自定义全局的code snippet。
9 V, x3 b& A$ z* K; W: c) x: `
8 V3 a$ H6 q) D3 e" g! X
- 选择新建全局代码片段文件。" U, ?7 G' ~& k& q: T0 S
+ l! X2 A" J) ^: C4 \- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
0 R8 Q* v- {( O
' D( R( @$ K/ x2 k- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。0 K0 C2 s/ ^4 O' ~/ M
+ o- h0 K- R5 Q0 O' X. z) v
生成的代码片段如下:/ n1 {0 U9 N A
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; 五、打包7 f9 q: _ e. N3 P& F
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: W- g' V. ~! p3 G! P% b: ]
六、发布
1 `+ E" E4 y: @. m0 Q Z 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!( ^$ P5 W# [6 |! t* y
/ e- i' B' [& o$ W9 ^& y/ e
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
# W7 N9 @/ R3 N- Z& Z) ?8 F
4 ~- f9 y6 ]/ y5 @/ X) x! V' c
七、结语6 C, G; o9 L/ w# @) A
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |