一、前言
* k( y( |" \ _7 \* f; t$ V 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
: P# D$ D% V% z4 [二、环境准备
/ I( x5 M' C& \7 |- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g; Z- M3 w8 C0 v9 G) W
三、开发者账号申请
# K2 j7 b9 b3 k9 \5 E 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。- i% m) s4 M5 U+ h0 A* J
1.注册并登录 Azure DevOps。
7 F1 c2 U' ?. `/ V% i* m2.选择或者创建一个组织(new organization)。
0 q# z6 _1 _2 d, \) V3.在该组织下创建一个项目(new project)。( F: r) F$ z/ Q9 R
以上三步都是为了获取开发者(publisher)的token,获取token如下图:, I8 W! W& E- m$ T
3 y# x9 C6 X4 f: N$ e% z+ H4 N7 V
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
5 `! K7 F! V3 G( f# J2 Y
c' t' }# z* \" W2 k( P# y( U. ?5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
3 d0 d- E2 o1 m1 `5 C h+ x3 A三、项目搭建8 n, j/ \2 B: }& x3 M
1、项目初始化( N4 s+ B5 l, @5 a' U. o' ~: y# M9 S% {
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
6 ~9 k1 D' j6 J1 c* J* N2 x: a0 {
U1 T: a9 N* J& C$ T& [
2、项目改造
/ B/ A5 R% p4 T' c7 t$ o; X 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:6 X- E, c6 R; N/ G: t5 L8 O( }
1.将package.json改造成以下模样:
5 H* u, K0 q( p- W{
"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包会失败。
- ~0 [4 Z8 C# W! _4 P* E/ n$ @* I$ x3、编码. G' z; p. ~& C7 d, B5 ~; y; L
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
) y& g) t5 }; L2 N% I{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
- k" {7 _( H5 o, w( k2 ^, u- k四、调试
0 ?' v7 x' b& K8 w* ? 单纯的开发代码片段的话测试和调试都非常简单:
8 I @! t4 f# d' U% R- 首先先自定义全局的code snippet。$ h/ K& ?! b7 B% ^5 \
) P* E, h, W! K7 `+ Y1 ~- 选择新建全局代码片段文件。+ S: d7 Q8 x9 F7 L6 I. ]5 v
; _$ | }9 |! n$ h: V1 j
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。! o M0 j8 K- u( `
+ N1 U; d4 w. P8 _
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。+ q" F" G3 ]6 k
* X, G: O' I/ b' _& t. c, n 生成的代码片段如下:) Y9 u% ~! X5 i2 x! k
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; 五、打包
; p. f3 b0 s' j" {. u+ l8 R 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
! Z U! Z; c2 Y; v% u' C六、发布- I. p+ b2 G" E6 C1 H
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
: t; |5 j9 g8 w
: ?. @" {) R* [4 c/ W0 w+ A 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
" Z. i3 m& ?6 G
. d! _1 d- E& e: Z七、结语( t$ w5 @$ D; p5 d, C! `
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |