一、前言
; f6 W& d9 V% u/ _7 R 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。' j/ G* F/ ^* k" f/ E% I
二、环境准备
) l, R8 {) s. V- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
( @/ S/ I! U9 k, n4 s# H! {/ q, U 三、开发者账号申请9 }3 D7 o+ K' N. L3 C) F
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
8 X: v! @. ?, i: W5 [7 d1.注册并登录 Azure DevOps。
2 R! R8 H+ N1 p' G' n* l! S2.选择或者创建一个组织(new organization)。
% F w, H4 [2 x* {8 {. ?, W- @3.在该组织下创建一个项目(new project)。
. D1 I6 O+ ^5 N) | 以上三步都是为了获取开发者(publisher)的token,获取token如下图:6 J+ Q5 U: o' M+ r
7 A% K1 ^& T4 j4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
6 h' M$ X4 y) K/ N8 k
5 @, F1 C l6 `( W7 s% n' h5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。! U) l% ?! {+ Q# R/ K
三、项目搭建: ?9 T. y: l/ a; F
1、项目初始化+ V- ^' ^# l- h; d1 x$ C- l
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。9 O% L% U0 s' n
" M7 H# v' O. j( U6 K3 b7 J2、项目改造
5 _. d. V% t0 C9 _ 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
% N, J9 W) j1 J1 D) a- I1.将package.json改造成以下模样:8 r3 _3 o3 |0 h7 O, b: ]9 s, z: b
{
"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包会失败。
. F+ o+ Q6 o' d3、编码6 N2 d4 l6 M- _4 }9 n! Y; v# k
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:. y- {' @6 O6 F; x4 ~' l
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。 b! u9 L3 u7 t4 R; Q9 |) H0 z( c
四、调试
7 l8 k7 f: t! h 单纯的开发代码片段的话测试和调试都非常简单:
6 G% M% C ?; E! E& ~ r- 首先先自定义全局的code snippet。& r/ E7 l" c, ]) ~% g
9 I- \- P$ o' G% ]3 N- 选择新建全局代码片段文件。
8 Z1 j1 ] ~; d2 q$ Q2 ?4 K& p
0 l, \( y2 A5 a) ]) ~$ {
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
+ b6 i7 \+ Y3 j2 h
$ q b: g4 C0 S+ D, ?
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。4 B9 r: }( Y2 X7 R/ s. G% t
. I' x2 d. S1 O. W+ [& J8 k' i- z7 d: g
生成的代码片段如下: P) k, g% v& B& n$ ?, G* z! J
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; 五、打包: t" Q# F$ L8 ?( z* ^1 z
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
; q4 K% `3 f& M9 b0 h. K* T m六、发布
# p, C7 J. [ z% q( h 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
2 j0 x! |2 R) k
1 z) K8 x9 n. }: B 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~. O* n9 K1 d% v. |4 P9 l& j! @9 o
" J# K6 [( z/ q( j七、结语7 A/ r0 O8 A9 Q6 V& }) R6 P
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |