一、前言
- B$ y. s% B6 D6 s 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。/ o( p% \8 n6 P6 c1 o. ~8 J6 A! r
二、环境准备# x' F( B" ?9 K" s5 A3 z" l
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
( @# F- u; y _ 三、开发者账号申请# ^, Z& L; O4 S! U) p* v+ {
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
- L& x8 _# j$ _9 ]. G2 d1.注册并登录 Azure DevOps。
% v8 a. T) Q+ J" e# g: M+ [* j8 b. G2.选择或者创建一个组织(new organization)。8 K( u# b( d1 e9 U
3.在该组织下创建一个项目(new project)。
6 s n* Z3 y' y# P* N2 t" V 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
) C# A0 N+ T0 z9 I, r
+ t, M/ u V( x
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
9 p. _2 {4 m/ \# j) R& b* h
! N* @6 B: D _" `5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。6 y6 ]: l# u5 O
三、项目搭建/ O( @' N. f$ p" U) h1 X
1、项目初始化
, ^! K/ X( Z8 c6 E8 ~% m$ x5 `( I- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
6 L) [8 D2 E* p# R; [! D
3 m5 Q5 ~' D. @& i( [6 S2、项目改造
: I- [& C5 {, L* ]9 U6 y" \ 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:* i$ c4 L0 D1 [1 _" P7 i1 o
1.将package.json改造成以下模样:
3 C4 ]) {2 f3 T5 [( u{
"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包会失败。
0 Z$ d Y1 D) K% I3、编码6 K8 g$ v% r# ^/ t/ r9 s% D! z
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:$ P7 ^3 \2 |8 Y& _. r
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。; W, r" C; A( }" d5 k H$ S
四、调试4 j% s- R5 @; {- s9 D6 o8 r
单纯的开发代码片段的话测试和调试都非常简单:
: L0 `* p0 K5 v9 k9 r$ y1 e6 y. C- 首先先自定义全局的code snippet。& z9 M- i4 @/ c9 v
% J) m J: h5 q: e* b+ @- 选择新建全局代码片段文件。
( c, T: F# w# H
4 A* N' T4 l/ l( J! o- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
0 k( [8 J! {( }
7 o Y: @+ ]0 ~$ M* W+ @
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。' `8 }; ~( V$ z) F% a
4 p3 ]- V: z8 ]* U( ~0 ~ 生成的代码片段如下:
% ?1 ^4 i, g! y- t# Mimport 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; 五、打包# u1 k o4 m0 G: H) q. K- ?
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。9 f' _# ]' H) H; v: f" U
六、发布3 a3 M S( |+ _4 F0 u4 u0 c2 P
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
3 j) E! _9 b4 B( R) g
8 p }5 C9 |) Z/ {4 k; i- z0 E
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
5 c {( o# G, o8 o
- Y+ L- Q; u, _* P七、结语
2 z- p3 V1 s; L( K vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |