一、前言
' @; q$ C _" i! s8 Q 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。. ~! ^7 @* t m1 F1 ~2 q9 @$ \6 y7 |
二、环境准备
; l7 G x; ~* p0 H- g3 q- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
% \" V! B! U! O3 d; v# R* L* E 三、开发者账号申请 t0 V$ `9 U" W, M
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
8 @4 I1 M) W- [3 {: E1.注册并登录 Azure DevOps。 l$ P) o$ O$ \3 T- ?
2.选择或者创建一个组织(new organization)。
, ^3 ~* A& A7 j5 n+ f* M3.在该组织下创建一个项目(new project)。% i. b! f' F( j* g
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
4 b6 m" r! k' Y
. p9 F2 _2 s2 G2 W$ V
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。& o @% M) O; j' o+ s2 v2 \
$ Y) S' i6 g3 c. O3 f5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。7 C- x+ o+ t* s5 A; v( N
三、项目搭建
6 J' Z. n$ B$ c- W! j& p1、项目初始化
. k6 d, A1 R+ ^! S( X1 ]; Q7 d7 W- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。# M1 O+ [4 Y3 u: C4 X0 }7 T- r' g
) v A5 m9 o8 C( I& k `* p) Q, G2、项目改造
4 ]3 O; x$ g4 j0 g* W 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
6 P' I. m( @7 f5 J9 `% ]. i; V1.将package.json改造成以下模样:1 `4 \" q( F# H% \8 l8 F. T" ]
{
"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包会失败。$ F' b* A- Z, X, o( j
3、编码
7 S, W& Z! M! _4 _ 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
% \. |2 y! W/ o6 X{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。( T$ |% c ^, K
四、调试
: k7 k9 U' N, q N% X8 \: ~* c 单纯的开发代码片段的话测试和调试都非常简单:
* N* ?4 H' }/ V3 Q- 首先先自定义全局的code snippet。
# B' D. `/ @6 R1 U! J" Y
/ s/ Y! G! o* u- `* z- o. u- 选择新建全局代码片段文件。
( @ f4 _# g: @$ ]
: U' Q$ u; D0 M- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。- @# I; @5 T; ?5 G J# u' i' m
1 [$ n/ i9 g& ]
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。6 L" A) B! }% n/ p) u0 b* ~' o) N
) ? a7 w+ f+ ~, j/ {5 @ 生成的代码片段如下:$ a/ Y% i% a, l. z9 ?+ [
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; 五、打包
; z$ }2 A i @! ?; a% p 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
$ _) F8 ?5 j& |+ v5 Q六、发布. Z; @, l0 q8 v$ F5 s
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
. ^; c( @: E. R8 ~
* S9 R. Y F4 T1 @/ j: E) Q7 P* ~
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~3 n! O a0 m8 T$ H$ ]" q
. z2 ?) v/ Z5 b& F* O3 |" C1 m七、结语
" X! J7 a1 H! `4 Z: b vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |