一、前言
q7 y+ n5 R- Y' r2 m: Z1 o 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。 u4 \& E5 B6 o8 b3 I
二、环境准备
" W# U, t2 C( A3 v, _- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
) }$ D5 X- K' [; E/ C6 W3 u0 ?! ~ 三、开发者账号申请. m$ P1 L( k9 N4 D( A8 G1 W
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
3 K3 B& }5 e( G9 S& I0 z: S6 y1.注册并登录 Azure DevOps。
' s' T G! O' y3 ^1 }2.选择或者创建一个组织(new organization)。
4 B; h7 w& ]9 U- e. z: w" L9 _3.在该组织下创建一个项目(new project)。
- U6 P# u4 `" s7 ? 以上三步都是为了获取开发者(publisher)的token,获取token如下图:0 L: k: I+ c3 K& Q! r$ q/ w2 n) N
$ d9 |- }- O; O6 ?
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
7 G# h9 d C# D+ g8 X9 \4 U
6 U0 w, Z3 ]0 N! ]) P
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
2 ?. V, O6 [; e$ G4 v3 q+ `8 @三、项目搭建
- E4 W* F& L) w8 @8 s# m1、项目初始化' i8 E( B2 C" N* x
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
4 w: j8 R4 c" B
7 H5 \+ t/ K) A8 m$ K* |/ F
2、项目改造) u( Q1 N! J. O9 o) @
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:, V: h- X2 J. G! g
1.将package.json改造成以下模样:
: c7 y/ F/ h* Q2 b, W2 I{
"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包会失败。
* i, t% L* k3 S5 R+ j. v6 [& u3、编码
" N) B( @3 \& e# W+ b4 X* i \# E 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:, k9 O0 S3 o& q3 P5 U
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。: U8 [' ?" S3 ^6 R1 K. w! }; m3 Q
四、调试
4 l$ \& K6 w* a# O 单纯的开发代码片段的话测试和调试都非常简单:9 u0 z6 G2 B( _1 D$ d. e) V
- 首先先自定义全局的code snippet。
" l& s# A* y V6 n6 V! S( u: H% U9 _
; s4 A5 s' b. u+ V
- 选择新建全局代码片段文件。
. n3 s! r2 p+ l6 K: q
, O4 N& ]; o9 A( ?$ Z
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。% ?7 X, d+ f E! a+ S- U! a$ U
) n/ |6 H4 [! Z- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。8 ~; u$ h/ `9 ~1 A
2 L* I, [: Y, ]3 B4 n- r
生成的代码片段如下:- Q! [0 h. W& f
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; 五、打包; O- ]: j* \& _" N4 h3 V
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。8 p, u% e1 B, k+ |% q8 Y
六、发布
) R$ [4 [; y' ?" F5 g2 m6 Z: p 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
! t+ e" X2 `: E2 I
5 f/ M; Q% a' i 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~. r. {1 E0 V" R& ^, p/ R" C: H
4 ?) g+ f5 o. |5 B( j, d9 f/ T! M0 @
七、结语
7 L5 ` r4 ~, i, c vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |