一、前言
$ t4 _; d/ b4 z; c+ e6 k 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
# J' H& P/ |' o2 ]0 e二、环境准备: J. t% X' s0 ]3 f! m- `, ]
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
0 g1 N N( x- y" f7 P S9 m$ `( v 三、开发者账号申请, K2 |; d9 O9 S3 Y+ Z. L7 \$ E
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。; l% `) y( M2 C/ ]' n
1.注册并登录 Azure DevOps。
* u0 N. g5 A5 x; O" B' s1 K2.选择或者创建一个组织(new organization)。
+ J( Y- K b5 s& Q3.在该组织下创建一个项目(new project)。; m3 k! i3 r, l# T4 ~
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
: h. P2 r. O1 Z8 U2 d' U& B
7 H' i% K; p+ a$ U) E4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
3 t& ]6 f4 }& I8 e; T' N
2 D u7 L6 R4 S. ~: g" ~
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。$ U% s" e6 C6 a1 Z# I$ U
三、项目搭建
0 a( m6 v8 p+ v" M0 v7 x' D/ D+ V1、项目初始化
* W7 N7 X7 o g3 E$ T* E- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
/ A7 ], z8 k- C
e! u* s- M$ \7 i- D p) B
2、项目改造
" j% G9 m) B) Y* u0 ], y 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:7 M% S9 j+ f/ U6 N
1.将package.json改造成以下模样:
7 G2 E8 _/ I; Q: F% \$ F{
"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 C" b# m# G4 F! I. T
3、编码: M- @% K2 l4 L B
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
3 K; A1 K9 G: H+ C: |{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。5 N( `4 b) d. H: z8 T
四、调试$ \, j; O1 c- i! ?) Y4 u9 V% S
单纯的开发代码片段的话测试和调试都非常简单:
* j: X& ^' m( l% a' q. y; a- 首先先自定义全局的code snippet。
3 g7 N6 h7 C3 H# e/ j8 ^4 A; V* X
' q' y0 o3 Y J9 r- {4 x7 s
- 选择新建全局代码片段文件。
; r0 Y0 m, s8 ^* e7 `# `3 I9 \
' g0 c) b# e* ~6 P7 r3 H- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
9 e F( {, L) m! I& K3 @) l
8 J. N1 G. H2 N% t; U+ S: }1 B- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
6 G7 ]0 C! ^. b ^- u+ _
/ ?* ~' B- `" I, i# L- W 生成的代码片段如下:
5 P: K9 i% K7 c( I# ^8 Cimport 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; 五、打包' W/ i/ T; X# h6 H* ?: L" X2 X9 ?
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。' P: W& r+ F: |& ^. w( B; Q, I, D; g
六、发布: \: C3 u4 ]- K7 _" _% T+ J" s. ?0 Q
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件! @# g- F5 t5 u
0 h, J8 K5 I" Y6 b. }
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
6 J4 O& M; D5 g+ a
0 v: I& Z# Z: W6 P七、结语7 x+ @( Z; J, ?$ ~# v( y% R7 F
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |