一、前言
( n( b9 | k [) q 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
% H% b8 _6 A9 p' z/ F2 J二、环境准备
; O5 n8 k' A$ \+ l! U4 a) r) ?- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
* @2 T( A6 y0 ?' I! p7 ~6 p: ] 三、开发者账号申请
' z; l( _* F0 F/ q4 M) ] 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。, I7 {, l A7 R* b3 a7 g$ r
1.注册并登录 Azure DevOps。
# h, j' P- u' i2.选择或者创建一个组织(new organization)。
( _! R, Z0 w! I/ b' F3.在该组织下创建一个项目(new project)。
4 o) a5 v5 U* P* M3 Z 以上三步都是为了获取开发者(publisher)的token,获取token如下图:5 \) m: S) P4 U& Z; a' c5 D
3 u0 p% U, J1 @6 |) v4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
$ Z, I7 ?) H! R" c
2 b. K C k5 M5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。7 {2 m) Y5 G2 a0 Q7 ]& t
三、项目搭建( N3 p7 u0 a t
1、项目初始化
$ F! [7 N1 G/ N9 W! e& `- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
* j( K% v% Y8 a; F# V
: ^$ y u( o! X/ S
2、项目改造: q* }$ V7 E, y( l0 J9 x/ [
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:# }1 S7 \# g P* V* h
1.将package.json改造成以下模样:
. {1 E: S, ~+ l$ P" [{
"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包会失败。
0 E8 E1 ]8 m1 V3、编码+ V+ e6 S' Z; k
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
$ n- t, o& b& g6 M2 E# 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。6 s& m1 O9 h# k/ @% m
四、调试; O/ G% p' x/ I+ x
单纯的开发代码片段的话测试和调试都非常简单:5 J# p: d/ g* h4 F2 f. }
- 首先先自定义全局的code snippet。
9 p( ~. t/ ^) ^0 _) O
. j" f6 r" c0 K5 i7 ]. p+ M- 选择新建全局代码片段文件。7 f b" r2 q& U
! ] F. w& ~$ P/ r5 Z# C- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
* L0 |3 ^% N. e; U$ \, S; j6 M
2 A* |& K/ x- @# ^5 R
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
2 a& u- y' ~0 f; x( R
+ U4 F" W" _ [; K$ X9 g' p
生成的代码片段如下:
7 P7 N: y9 X% c ~ nimport 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; 五、打包
) c, |; P6 n- i6 W, ~4 L7 a7 T# \ 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
& k+ y. X' h' U7 e. t六、发布
, {2 k) ]+ _( A" F P 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!! x6 h1 s" _ E; C
8 E# Q; {( A7 O% B; I 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
' T* `2 e5 U+ @, v& }$ U7 |9 r
3 \- ]; \3 O. V0 T$ _
七、结语3 q3 ?% Y" Y* c+ J: _" R
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |