一、前言- e$ ~- T. M! K, N2 \) Y
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。: y; @9 Y+ T# i$ y3 k4 y
二、环境准备
* K6 ?1 V3 b( U5 [- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
1 E- l4 r8 T' l$ T# k 三、开发者账号申请- o# q* S5 e6 N% C# I. O5 I
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
, M R! f- Q& \4 n( J6 X9 m1.注册并登录 Azure DevOps。
% z0 k+ [& \+ `7 S# S; n' q/ F2.选择或者创建一个组织(new organization)。4 B4 d* G8 A) K; U& ]4 \
3.在该组织下创建一个项目(new project)。. o0 ^. c6 F/ V9 [! Q" x
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
7 J* K" A7 B+ C
% H: b1 d6 x6 h7 h1 d, A6 }4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
, j+ [& s, A5 J2 f' f% ~
" E; p/ V1 Z: [' l5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。' g$ s3 i5 X7 F6 B+ @1 |) q+ a' r
三、项目搭建
8 g! n, R3 z& n4 V9 Y6 Q+ X1、项目初始化( Z0 S, X; N) w; {! ?7 v
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。$ B7 z: G+ i+ [6 v
1 i4 O7 f: y7 M! q
2、项目改造
% A! K y( z: V! {% G' t( f 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
+ Q4 @' y/ u0 `" R9 s1.将package.json改造成以下模样:
$ a+ s8 G3 H: S1 M* q{
"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包会失败。/ ^) v: Y- t! W
3、编码
. a7 I4 G5 n9 p# \$ [ 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
5 v9 k1 V3 q1 y1 F9 l0 V{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。* m3 k# X1 t! ]9 o8 U9 u# |" O
四、调试( A. y! l- t; ^5 S! E( Z
单纯的开发代码片段的话测试和调试都非常简单:) Z3 D! Q' N- B% M, y& L, ]( c3 Z& w
- 首先先自定义全局的code snippet。4 N6 o6 d( c& C( W: H
, O8 X3 [$ e& C. w) j ~- 选择新建全局代码片段文件。
1 o) g7 e/ Z3 B" z# _5 J D- |
$ K! v ]* I$ ]% ]
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。- C' }* U- k; ?( `3 ^
( n7 R7 L/ b- ?1 f2 z% u0 V
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
w* r+ @; N5 X; f8 j
6 j" M1 X* v# B5 x# N2 T
生成的代码片段如下:
3 J8 z4 ^! a' c( t) Z: ~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; 五、打包( l; m8 B1 {" R, S9 X# \' _/ G
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。 w* `0 O4 r0 \
六、发布
3 ]! V/ H& H, | J! R9 f 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
/ E' Z+ L6 B* L8 ^. w O
. P6 H6 g! X5 U9 j 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~% H) A) T5 B% j" r
8 s+ ]; L9 B) b3 h+ F% i+ e& E
七、结语) g x, p1 W' X. X: n# s( f# M, o
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |