一、前言
# J! ~* L& t/ u" m' K1 a 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。+ O, M9 e& |% M# E% P
二、环境准备# ^, W' Q0 \" `- m7 K
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g/ @5 [; [$ Y: Y5 s
三、开发者账号申请4 O# \6 K5 c: o; F& n. m
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。0 d+ s4 `- m- W9 c. S8 L1 z
1.注册并登录 Azure DevOps。
# `6 J1 s( Q, d; m$ R2 K' |2.选择或者创建一个组织(new organization)。! u2 e& k2 ]) L- n2 W. `$ e0 ?
3.在该组织下创建一个项目(new project)。
) o7 c4 g9 }" g) m 以上三步都是为了获取开发者(publisher)的token,获取token如下图:- \' d3 A, Y+ x, O
% z) D- ^0 p6 w0 h
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。0 K" s$ k" m+ B
) l( a* m, m3 R* J' R( T% ?
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。% l( X! X* N5 k3 `7 M
三、项目搭建4 S& p5 g y1 s; D$ k* _
1、项目初始化7 ?9 j' L' i: d9 _8 E( r |! k
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
9 A. c/ w) v6 l, ~6 B$ H: ~& d
6 K$ |0 N; B) n/ W1 E# c; K9 N2 m
2、项目改造
# \: ]0 L$ H+ S8 N# C" |7 Q 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:7 g1 W" y+ |2 w3 r* f1 B
1.将package.json改造成以下模样:
1 T# I# _6 M1 R% J# O{
"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包会失败。
- D7 r5 b) T8 j+ X3、编码" x. ~, Q7 N& U- O' b
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
3 a1 Z8 \6 J+ F8 k, f0 t{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。, V: p) F% h- E0 f: u/ J- B
四、调试
( L8 _) S! P2 t' Y' j8 X 单纯的开发代码片段的话测试和调试都非常简单:' G; [: x6 E0 c
- 首先先自定义全局的code snippet。/ h5 G/ ?+ E0 h9 h7 ?# y' ^
. {" l6 _ U, L. Z4 j$ n8 E- 选择新建全局代码片段文件。
; g& o) M7 _. W7 F. J
1 G0 d1 y! [3 g& d+ E' K( Q
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。1 `, V1 j+ e: Z5 b
, N6 }: J5 _* T- K9 m- y% @6 X- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。# A- t5 H' X. K- o
8 o5 V5 g, u' Y( R! y2 k, f 生成的代码片段如下:
. v- @: y7 w$ D1 G" ]2 Jimport 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; 五、打包8 ~4 U) G1 t! c7 a3 i
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
# x% T8 V+ Z& H六、发布
* g3 P, b& w0 u# a 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
+ V9 m9 O3 O* M- h: P$ Y7 ?
* n7 k4 K$ [0 {1 h( f8 U
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~ i) ~0 R* Y( d% V% g+ }. Z- j
: v1 P- j5 D$ A2 \七、结语
: ^/ |& L9 i& m1 R$ b vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |