一、前言5 z8 r* Z% H4 L
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
' n; V _: V4 w1 \- l( A二、环境准备
6 ]# x0 \! J2 O* \8 M- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g5 e6 V( c. f; I
三、开发者账号申请! w$ I4 b3 ^8 S7 b3 F; a! V" ~
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
9 _2 z$ b* a7 h; o$ X1.注册并登录 Azure DevOps。# r6 V t# L# ^1 L, s$ {
2.选择或者创建一个组织(new organization)。/ X- Z! W2 k+ U% a$ @
3.在该组织下创建一个项目(new project)。
8 A7 G- ^: d O. H, a 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
! a) t/ g$ T- b% m
& |2 R2 R. m# W0 C- O. I
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。& D2 f, E8 _$ H. C
; l/ P( e$ Y: I8 z* N4 f7 ^5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。0 ^2 F$ T, E! }$ Q' I: y4 C5 h" l
三、项目搭建
/ x% O, R9 D2 ]" n$ O! W n, Y1 w: m- ]1、项目初始化
* N( V7 P |3 h$ K0 Y- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。& M1 M t- V; k1 `* X: c: e
8 C; d% ~6 P$ Q
2、项目改造9 K5 D0 z; n: B
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
- l/ M) b8 s Y) M& M% \; Q% i+ K1.将package.json改造成以下模样:" S) g1 d* S( f! I% ] A
{
"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包会失败。4 F" |/ Y& o% l* t% ?. _9 q
3、编码
: t; @, x. A4 g) X- Q- V 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
! _3 o4 z5 p4 g/ H# U{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
L* h+ w' ?" E; R. p8 Z四、调试9 [/ x. W! `5 C
单纯的开发代码片段的话测试和调试都非常简单:
! ?! v3 u8 R, u# S; u- 首先先自定义全局的code snippet。
: g" A3 M6 `5 k9 {! j1 l Z: e f" W
9 d$ X) ^6 c- p# F# @
- 选择新建全局代码片段文件。
) h8 z1 C7 V- Y$ N3 U+ C3 G
" w" A) S u. S- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。) \% S ?6 V; v7 k. Z: R
0 I. { r# x1 e, T% g, L- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
# X8 ]! m4 H8 p: W6 x2 {$ v
0 m& u9 `1 v) I% o9 {
生成的代码片段如下:
3 ]' x2 r, O7 v" D) t* \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; 五、打包
6 c# ^4 @( _2 m: j; ^& o9 m4 H 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。8 t" j7 h% |! l3 |5 F/ [
六、发布
\$ C* C% e& b5 `0 p* ` 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
3 a9 u, C4 ]- g4 W9 p0 j7 a4 r
! @0 }* G- {# N5 a/ {# j6 w
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~* J# ?7 `" T" w/ d
5 W+ `1 t$ P2 `: R七、结语
' {/ L4 U. ?/ l; g vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |