一、前言
. R4 z" a; r6 Y+ [1 I 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
! c6 X' X1 A8 ^二、环境准备
8 p3 D% Z: P( j5 S" m, s- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g9 ?- H5 G+ t& q( r U
三、开发者账号申请: E2 @; I l/ V
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
% i: O" |/ q6 l7 D, o) d1.注册并登录 Azure DevOps。
, O( e1 K0 w/ a4 R2.选择或者创建一个组织(new organization)。7 \& X1 }' }4 W7 r, i
3.在该组织下创建一个项目(new project)。' m+ C( E* K6 C( c5 Y* r2 k! h' K
以上三步都是为了获取开发者(publisher)的token,获取token如下图:7 i9 r) n: {& p9 t
# `/ ?- Q) F( p2 ^4 O* n( R4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
! ?' e! g) }& I
) |7 Q9 q8 \" j5 f* h0 F, J/ [
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
, p% N' U5 q7 s( I" ]三、项目搭建2 X4 U( N* U/ v' V# E+ v7 d
1、项目初始化
# x# x) b& `( i6 l' G- b- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
# m7 J+ R: H |% T" K1 n6 ]# h3 y
& E' A# r k5 \/ D& _
2、项目改造7 w4 i) w: U1 E2 S
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:' H! r. O0 O7 l# s. d( L
1.将package.json改造成以下模样:
" }3 ~& A/ x5 n7 T0 _. J{
"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包会失败。
7 G) T2 X' h# P& V3、编码
7 K( }" p( T |- t4 R 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:8 a9 z: Q% o2 Z( Y7 a1 y2 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。# m& u* }8 o9 B# n
四、调试4 u0 t8 E6 }4 q0 L( u
单纯的开发代码片段的话测试和调试都非常简单:/ F! i6 q" |$ s7 m
- 首先先自定义全局的code snippet。
: K( t8 J+ w7 M
# l7 Y, s+ \7 J2 g3 h- 选择新建全局代码片段文件。3 ?+ G9 [1 B6 E: v9 l' d
, s; J" y3 }+ ~3 p- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
. g9 A7 e& m/ q, X
[& L9 H5 ?. ~2 D- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
3 I% j' r$ x7 U) K) I6 f6 X
8 j. y% v" ]* F
生成的代码片段如下:
# H3 g5 M& H, D3 Z- M" d/ oimport 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; 五、打包. j: M. K8 C: `' R F& V
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
) r }# [3 o- ]* q六、发布
" K& b8 I+ L9 M$ E% ]4 B+ J 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
+ h1 r" C$ }: Z
* q$ |9 Q9 x& a. S; L 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~" U3 s$ _ k- k' O: Y
+ K& s- U8 u) @7 K% B* c# n) P, p
七、结语6 S8 y- [" c8 W3 H) ]1 e
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |