一、前言 ; l$ P8 U; w2 F
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。. R1 X7 _9 k0 |: b
二、环境准备 & c; V. \$ K' W2 e4 \+ l. r
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
) L Y7 [8 c8 { Q* n( ^ 三、开发者账号申请
, E, y$ g1 U) ?/ s( E/ \, Z 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
) P5 r: w) z: X" p* v5 D1 B 1.注册并登录 Azure DevOps 。
, l; \6 G6 H" u+ N 2.选择或者创建一个组织(new organization)。3 m7 V: x. ~/ R' G& L$ i4 ]
3.在该组织下创建一个项目(new project)。 t* Y' J- S4 _: F
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
. l9 I0 I# \4 d* r/ Q9 {
& O/ v1 Q# L! l& _ d
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
4 g0 M3 \; X# t
; c/ |, j4 @% u$ Y 5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
! ?7 l9 F% t7 F8 I' E 三、项目搭建
d9 S, Z, r8 n+ b8 x& l 1、项目初始化 ! P8 H' n; S) r: |
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
* S: h8 B% ^4 b& s5 q& O( G
4 ^- I& x# m* }3 t4 f) W 2、项目改造
8 O- d, C. O, i# n! ^2 x 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:7 l( z0 Y1 V6 q! X0 v4 n* A& P- z9 l
1.将package.json改造成以下模样:
8 \" @$ V, E% @4 M; ] {
"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包会失败。
3 P6 q* H! K. W v 3、编码
( i9 L+ w% S; e1 z 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:) |3 w& x( A3 u8 r0 c' D; ~
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
7 P0 |* M6 O. e7 c 四、调试
4 X6 n( p4 V( b, F' m 单纯的开发代码片段的话测试和调试都非常简单:
& _5 C- L, D$ z% ? F 首先先自定义全局的code snippet。
' i0 F5 o$ Q& n$ U0 @
% l4 z$ s _# s5 Y( f! G 选择新建全局代码片段文件。
; x6 q/ m C( E' M8 H0 q
; t0 [4 |) \; d
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
# X+ ~2 ?2 k4 [7 _! H
$ M; X) o: B( `% P) j: h command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
' k0 h, n# \; X- a" z
, Q& y6 R2 I2 |/ n
生成的代码片段如下:+ d0 B2 k% ^9 ]$ _6 v3 N$ @
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;五、打包 % d$ i' N8 Y; }
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。# O2 A' K+ \! l2 N5 a$ q' I
六、发布
. a8 l/ O" k) v$ x7 U 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
! l8 J( z- Y6 m+ F. N' h
( C- T) k8 w* o, X. J
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~7 B9 h) x) \- \1 Q8 n
2 z' t) x* W' {6 {2 O- |' f 七、结语 4 T D* a& w5 f6 K
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。