一、前言
: ~/ Q9 I$ M' N+ h 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。0 L) H' _- S6 z4 w8 F$ `4 p
二、环境准备
4 |0 b- L( Z/ c7 O4 ~7 a- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g! m" @6 q5 q& J
三、开发者账号申请
+ p0 }' A& s% i. T* `: x M 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
2 c& f4 j! `- M7 J& a! R1.注册并登录 Azure DevOps。
9 [! Z/ i1 i) m H( L8 Y2 m2.选择或者创建一个组织(new organization)。
* d3 M/ T1 y- B1 m% Z3.在该组织下创建一个项目(new project)。9 I; J0 j8 _3 q- o
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
" Z2 \, j" A4 k! C! k
1 o5 L2 ~9 D2 R7 i7 q5 E% y' b# F4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
. o& q% V1 L2 T# Q' b1 ?
}7 E5 h1 F7 X: A+ t. c5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。$ J1 Q- j q- h. |$ F
三、项目搭建
, P' H- a8 M5 O5 l7 x1、项目初始化
& z; |! w4 U9 K* _( d' F- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。! @" \ F D1 z2 p
! u+ q! W" {2 b
2、项目改造
: f1 I" P5 p) ~$ n/ s 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:9 W- _/ V2 i' s0 W$ Z3 Z2 v
1.将package.json改造成以下模样:% |% ], S9 r4 x
{
"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 ?1 I1 r4 [% |' e! v3、编码
0 h8 Q `8 S1 R f. `5 m 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:5 N2 I9 {& [6 b) |& O0 r* I
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。" Y$ W9 ^6 v2 t
四、调试
Q" g2 ^% i- | 单纯的开发代码片段的话测试和调试都非常简单:6 {) a* v+ a. z i& c9 @
- 首先先自定义全局的code snippet。
( [4 \1 P- c2 I4 d) m; {. }7 N
9 D) S' \3 }* h4 c5 U- 选择新建全局代码片段文件。% c; _" t5 Y2 _: n, r' V
3 n' ^/ \, h& o! {+ b/ V
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。) E: d) E3 a, ]
4 V3 H3 Z) G7 f. q. ^2 Q; {
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
, U- |5 n9 q e/ {" ]1 f
7 G5 k) C6 t$ ?/ R0 i 生成的代码片段如下:
: ^7 x: d4 }; `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; 五、打包) [: u& u6 h9 j' l* p
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
, j5 _! t0 l: ]' o( a9 G六、发布6 g& v/ ~; @$ `- q4 r
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!. d( w0 F1 F* G. L+ |* ^
: U; E0 ^, u4 H) h. F9 {
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~, t4 c& ?8 x: N- p o
# {+ B: q( S% J1 b8 U" Q/ i# M# ~七、结语" P6 x- I; X5 s+ `+ I% B7 ]/ M
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |