一、前言5 I# o( ?% d: n
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
8 G! c( |; [( M. h" g4 ^二、环境准备3 O0 _7 k6 ?* m1 K
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
# `" j l! q4 `) \3 G 三、开发者账号申请
! U0 c+ |7 x& K9 f3 ^6 R4 ^ 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
' o/ j. i6 h L6 V$ w+ \0 e/ P. u1.注册并登录 Azure DevOps。
" l6 d2 [& X2 ?- e4 O, ~- I2.选择或者创建一个组织(new organization)。- F) }: f7 H# L$ D3 G* [& o7 t
3.在该组织下创建一个项目(new project)。
0 d# v$ c# _( R7 A 以上三步都是为了获取开发者(publisher)的token,获取token如下图:4 \4 E8 y- G% k9 V: _
$ Q3 y& Q4 h5 ~& Y7 i
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
0 S# N8 a5 n/ T; H8 J
* A- @% k2 g& t! ^. R
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
$ X" \4 P6 x- Q- E+ q# i三、项目搭建2 o0 c- ?0 m/ }" T) T' h" S
1、项目初始化* J: T) G) |: K! _2 m
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。( N& I. t. U) x2 m/ _; F
8 {1 L( c% s; `; I( i5 v3 H
2、项目改造8 h) o7 J# w$ ~4 l9 [. Q
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
1 ~* J# @4 T3 V3 e1.将package.json改造成以下模样:
+ c( u, r1 B+ 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包会失败。9 }( t; [$ B. B2 o' s+ C
3、编码
$ Y' a5 M; ^: q ` 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
% ?4 {7 h5 x6 [& ` y' k- I0 T{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
o; [# c9 v6 p, A( V四、调试8 G9 F. Q" y. G% s0 E, F O" c
单纯的开发代码片段的话测试和调试都非常简单:
* _! i* Z2 A5 U8 o* @3 B+ h8 b# i- 首先先自定义全局的code snippet。
# B( I ?! t! J. \5 Y
0 j; Q# s# T* O7 w7 _8 N- 选择新建全局代码片段文件。
3 J8 v/ }9 k. G- b; [8 A: V
, l' Q4 E4 b: ~( I& N+ \- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
4 l" \0 X4 `4 o0 f
: z( h' V7 D2 S) v- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
! V( i2 ^- H& U/ Y/ b/ `' N
: ?+ ?" \0 r. O- U& q1 E
生成的代码片段如下:; _; x f! `9 L6 Y
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; 五、打包
. `9 Q' P. Y6 g7 y 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
. |2 ?2 e% [7 P6 k! s( R! i5 q六、发布
' I' c2 I* ]: |: I( H5 A 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!2 _. Q' X9 Y) P
5 f) j3 i. l" c# Z% ], x) S 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
& M. `8 s4 G% Y) b8 x7 W# s a
; A1 u4 Q1 Z$ W; J
七、结语
, X5 n3 v6 `" H, R0 D& n7 y9 \ vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |