一、前言
/ w6 h k# @5 i4 a& N3 j" \8 R 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。# i6 Y+ O4 N6 L4 o
二、环境准备
! s. o$ i1 P: \0 v! A- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g# P% c* u- B: w; O8 Z$ l5 u2 Y
三、开发者账号申请
, I7 g; _" a! m1 |% R' s: H 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。9 F! t9 m5 a5 y3 ^2 C6 Q
1.注册并登录 Azure DevOps。1 x1 ]6 c" S& J+ ~: ?
2.选择或者创建一个组织(new organization)。
% ^4 M( w0 H, N' \/ {3.在该组织下创建一个项目(new project)。
. K7 R9 l0 P; G$ d 以上三步都是为了获取开发者(publisher)的token,获取token如下图:) q3 d& V, v A5 `
5 B$ z3 a" |' q" _4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。4 ^/ Y7 r/ \9 K- p% A* i! m7 @
0 c" G4 Y0 X J* t' S% \
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
+ o/ `6 H4 i7 X2 v2 B& G) ~% ]& M三、项目搭建
7 x" P1 `/ X/ @! B; `! y& s1、项目初始化
: W+ n( }* i: \. f }1 d3 E- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
" V9 i- h# P7 P
' Z1 C' x4 @5 u5 ]5 O5 w& e
2、项目改造
' r, ^) T1 z/ _7 q7 c 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:# F! y( W$ }, g- w' O% J' z. y" s
1.将package.json改造成以下模样:) p5 V% t/ g( c
{
"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包会失败。
! v8 Q9 C4 f0 }. E& }1 {$ j3、编码* P+ Q4 y( ` U( [6 q
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
. q/ z; f4 K; U+ f5 g' G{
"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 {& ?3 Y" I$ w& E8 O
四、调试, ^% Y" \1 Z; u( k
单纯的开发代码片段的话测试和调试都非常简单:
3 Y, p; \$ _ c! o. O" v& z- 首先先自定义全局的code snippet。
, @1 j0 }8 W7 m. T8 c' ^8 R% z
4 |& v" _: m# U* s" |
- 选择新建全局代码片段文件。; [ v# C8 V9 j' n& r3 }
) y/ G. U' \; V/ ?
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
& i! j/ X x. v# u7 r; m& `) S# ]
# z: Y0 P+ i, Z+ K- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
' `. C# w, a6 ^- A. Z% Z1 l' M
% L! T9 f8 n+ l6 b) h6 c) H% t 生成的代码片段如下:4 q h# z$ R0 g4 Q
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; 五、打包; U+ |' W! ?8 @2 z7 r1 j+ j: W e# p
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
4 ?+ N2 B* }5 _) ~3 p+ ~1 I6 L, x6 {六、发布
$ q2 R3 P* W- F" P+ Q8 x' I 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
* ]3 X; r; V6 X! I3 x2 z
' i( k- ?6 Y4 b3 \7 h' v! Q
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~- b8 d4 x C1 W" p( j' D
+ l7 m% q* ?6 J L7 P+ @七、结语3 k& M4 Z- f2 O/ K; Q* A" g
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |