一、前言! O3 j; m7 S/ ~4 J7 Z- C
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。/ z) }; |# x5 [/ U8 \# N
二、环境准备8 I3 }! q9 i4 r+ T$ C S* Q1 P+ I- \
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g6 y4 {2 D8 {# C
三、开发者账号申请
6 ?8 n/ l& n( v3 k; p9 q 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
& B8 M, z9 _" }% F+ I5 s1.注册并登录 Azure DevOps。
2 {6 ?5 R! ?1 E% T! m$ w+ O/ B0 Y2.选择或者创建一个组织(new organization)。( H$ A1 s* w' @/ b `
3.在该组织下创建一个项目(new project)。& s( m& {8 i) ~0 T: L" D
以上三步都是为了获取开发者(publisher)的token,获取token如下图:! J4 ?9 X8 R8 e3 M, z T! V
; m/ w+ H- E" ^6 m0 w. q) Y" W4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。" G. k! x0 @) o) W7 \$ p
6 v7 v6 E9 |/ M- [$ y) e/ F- C2 C
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
' Q. w2 m4 ?/ l3 W三、项目搭建
' c( j# g+ h- E- Q1、项目初始化
' g9 k" ~/ h* g' E) z- `" `- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
3 n6 N7 w* [, g
2 q7 {7 w, R. W" |& u
2、项目改造2 l0 M7 Y% x# ^( W3 Y& u+ J1 a
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:2 ~- v, d2 S7 z( `5 q4 ^
1.将package.json改造成以下模样:" S1 {# r Z2 o' b$ j" O- n
{
"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 k4 Q, x. {" u4 M% A3、编码- Z3 T s9 u& G& W
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:$ i3 n4 Z( ^) p4 j3 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
+ |: n% N+ @- }& J" W- v四、调试* z) ?+ t5 [0 H7 J
单纯的开发代码片段的话测试和调试都非常简单:
0 H! {7 @7 r- i/ {1 \- 首先先自定义全局的code snippet。
0 Y0 H/ R( O, D( ~" A
" ^* |& o0 X& R. e* L. z* j- 选择新建全局代码片段文件。% ~; @1 `( _& p& r S; w( ~! j8 x
?! S" v) h* p6 M- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
% u- G& e3 p: X
- A& z% ^, o) ~; x9 d9 a" e4 C
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。0 D: M1 m3 U% L) F
% I6 @# G; Z3 P8 t8 A& D, v( v
生成的代码片段如下:
+ W/ s- d7 O8 e9 B: L& simport 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; 五、打包
# J3 ~" r7 D; p& V 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
6 K+ f# B! Z) L+ X0 ~六、发布, j+ T* w- i5 H
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!: l! L, }/ U( Y$ K. @
! O8 l6 H, \/ ?& t: n* Y0 U 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~' @9 ?: c: c. M: H
& Y" {# u! Z; y0 o: U2 Z3 ]七、结语
$ ?# h y( G7 `. Z' j1 ] vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |