一、前言3 x- E3 G" r: ?7 G/ q
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。3 J$ g* `* ~6 Y: A
二、环境准备
. r8 \, o5 A1 q; `. i) N- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
( ~& W9 ~( \: v( X+ l7 |4 k 三、开发者账号申请
0 V2 V! F& A* Q 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。3 f# ^2 X/ S9 Z& t6 V4 V
1.注册并登录 Azure DevOps。
# x4 O' m* {- ]3 w0 P: W5 R! }2.选择或者创建一个组织(new organization)。
8 N' D: p5 \3 R Y3.在该组织下创建一个项目(new project)。
3 x S0 _0 L0 q3 @. w) H+ G: a# m 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
4 x. u+ M1 G. G$ L3 B, \& b$ \4 J
3 a( F1 N- L& N4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
. L# Y ?4 C0 S( }" K: |- {6 n
9 ~2 Y, a( s+ h- T$ y& A/ _5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。0 m( b% K; i# k) t
三、项目搭建9 u* y: }4 x: |* a% s
1、项目初始化( d6 r* p* `4 Z
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
) M/ X$ a. A4 M. c9 Q
6 u8 [% Q$ d8 i' w2 W0 l" Z! N X! s8 C2、项目改造
: ?2 Z8 {3 C$ P! S; S8 X+ I2 R) e# x 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
5 q1 x# n4 C! x7 K) T; C( R1.将package.json改造成以下模样:
6 D" M) v$ v$ v$ v: p+ v. L{
"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 a! _7 V: J# | F2 l3、编码
$ O8 ^, G" M+ Z! {0 F 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
0 {; n q& u1 q{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。; Y3 M1 ~" S8 I* e
四、调试- J6 F% y' f! c/ y/ }/ |
单纯的开发代码片段的话测试和调试都非常简单:
5 j, T* s& I8 ^1 Y- L- 首先先自定义全局的code snippet。
( G/ V1 w) L' e3 T
3 F. X1 }6 p; f1 |6 S
- 选择新建全局代码片段文件。
" ~) V, d8 W# V, \# d1 l5 g
3 I/ x" o% b0 l3 p- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
* n D [: K( n4 c" V5 j9 ~. E1 z$ x
5 I- l0 v+ ~4 w0 d. w, e" _) b6 T
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。$ m; S6 n9 c7 P0 [/ r! s
" o7 ^) _: ^) ?/ A) m
生成的代码片段如下:
, q0 e/ W. ^6 |9 h! ^2 [4 {% Q& himport 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; 五、打包; x- m0 G9 @2 t4 j
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。$ _6 G9 Y0 g9 ]5 Y; F
六、发布9 M/ ?" h& d: S9 |2 O
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!# k3 u" G+ @6 u% h3 ] }& \
! s7 T) W0 A" X! P, o* V 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~" M: b z! O2 T/ |+ }5 k
: H# ]/ R& K3 o
七、结语
; B8 d" V: h/ w( u$ z vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |