一、前言
8 b- s; Z' h5 K4 p9 e8 P9 Q. O! W 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
& j3 h( @ i/ t5 R8 J* i二、环境准备6 R) j$ v- e+ R& V' U' g" T( z' u
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g \! p% k( G- {7 K1 v1 R# {; B
三、开发者账号申请
8 P* B, t+ d! j 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
2 f" [; n1 k& e6 d7 P$ x1.注册并登录 Azure DevOps。' b, a. j o5 R8 o& k+ Z! H
2.选择或者创建一个组织(new organization)。
1 x( l% @ L3 D5 q# C* {$ S! B4 {4 C3.在该组织下创建一个项目(new project)。5 T8 Q! O, T) M( {5 S
以上三步都是为了获取开发者(publisher)的token,获取token如下图:3 i. ^6 `' t! ?& S
5 \, {+ Q5 O) b' i0 }2 [
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
' L' P, V* g0 z9 [% W* b
: t/ e! E4 Y( J ~, n5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。' w- r" w, Y/ o
三、项目搭建% |9 v: i4 K" p+ P) j
1、项目初始化
: E& z7 V4 ~$ I: D. O4 A7 A4 ?- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
: K' C) X9 X) [, m$ a4 l6 ?2 q
! n. u9 k; V9 \/ \2、项目改造# G) z& Q$ V' y( Q ]- d1 x
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:/ [% G8 J; o, M) b
1.将package.json改造成以下模样:4 y- d- ~* {+ f3 s7 n6 K
{
"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包会失败。) ~1 y% K9 L+ f" S
3、编码
+ H5 g$ X* s- q: y$ C 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
x n! V* n, A% 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
( h ?+ ?* c* r四、调试
+ z! G2 C2 U9 o 单纯的开发代码片段的话测试和调试都非常简单:. x- `' B# \4 E) _7 P% K
- 首先先自定义全局的code snippet。, q! C' N v& t$ @
/ A- d0 S- y F8 S" w- 选择新建全局代码片段文件。( _7 U S8 a3 ?0 Z2 o4 Q, K
8 a# P* D9 O1 ]7 b0 J
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
" b: @# F. W; w7 _ y
% t* a& }+ c1 j" T- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。! Q Z7 w' k& ]1 Y! x0 h( x2 l4 v4 m
7 M4 r; B8 B; @! o2 c 生成的代码片段如下:* |0 E9 Y, I& X9 w* T' O2 E0 b( A
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; 五、打包
( _& v$ X% a3 W8 P8 E% \7 P* z 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
]" P& ^* @7 ~) }六、发布
9 M1 d1 r. S! {6 ~ 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件! Y8 y5 @7 S* }
$ I* E5 r, E6 k+ J 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
1 Y" A8 C+ H! [
/ }3 p T% [ o- G3 K; ~( E
七、结语/ I G7 @6 Y& t. N5 o- v
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |