一、前言# j$ F2 Y; g7 t$ P* D; i* \% d" a
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。4 X$ Y: q! U4 ^" H G
二、环境准备
6 k' Z1 L* c! Q# Z& L- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
9 a0 L: |6 M; v9 G 三、开发者账号申请
- c: D w2 A- z- K 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
. q h2 Z# Q0 i9 D5 I( P1.注册并登录 Azure DevOps。- A- U- C6 f+ D4 d% M8 f4 Z' B
2.选择或者创建一个组织(new organization)。3 n0 W/ U: e7 w" n9 B9 \4 }. m
3.在该组织下创建一个项目(new project)。
3 ~' [9 c- q) m" ` 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
4 Z9 g, U/ b; |/ l1 v2 P3 g
2 Z- E% c6 A. a7 l
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
8 ^( L' Q' ~- J B# V
( D" E1 j" g) W- L9 c: V
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。. P7 J2 P8 o& Q) g0 o
三、项目搭建
- g% k6 d8 l4 j1、项目初始化
; {# ~' N7 x6 t$ S7 s A- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
8 | W+ Q# b v
+ s) A2 |0 N! }2 z* \2、项目改造3 g7 V$ V: d' H4 p
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
# Q6 \3 Y5 Q# b1.将package.json改造成以下模样:+ h8 }" P5 x$ v) ~
{
"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包会失败。
3 t1 Q% T2 y7 z4 U" k/ I. t! @3、编码
0 u+ A: r, E" B4 ^/ a 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:) L8 k6 G/ O0 s* |7 L* d8 E
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
' p! ^$ r6 G8 ?. N; s! O; L- R四、调试" _/ m D' N8 I% \' e |
单纯的开发代码片段的话测试和调试都非常简单:
: k" `2 m P( t8 ]/ B- 首先先自定义全局的code snippet。
0 ?( K/ I9 W( b( O, G# D' J/ {) T
! |. W* v& T) g5 F! ] {6 k$ y2 M- 选择新建全局代码片段文件。
. ]3 U4 E. W: n% u' s0 y* [
0 {/ f0 l5 `/ E# f4 C- O
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
# a1 N4 N# K% e5 a4 j7 d1 g$ J. S
~6 E3 J+ G, A- t& Z: L3 Q; x- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。( g0 g& p/ G7 Z" y4 r
* ]6 N+ ?/ G: m0 Y 生成的代码片段如下:
$ @; d( n) Z* b5 _1 V4 A2 pimport 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 \7 T B6 y5 X# Z# E p$ t
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
- F Q# e' f7 h, A# y六、发布, G+ {+ a2 R# n
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!: O! z2 ?! x! F, ]& J
9 O' G( E% ^) d' ]/ k: M
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~* T+ f" B1 Y5 t7 o
. g3 F3 H2 |* b
七、结语
; B* c" o) `1 x2 S, b vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |