一、前言
# j5 S1 Q4 s) T 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
, E4 X' T Z5 L5 [6 J二、环境准备/ m6 h$ V( r K6 s
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g. n4 F% r" u, I; t
三、开发者账号申请
! c) r) [, z) A+ ^ 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
6 E. r1 N M1 h' ^% P3 x5 a1.注册并登录 Azure DevOps。3 ?5 |' q! m, |2 q, d1 g
2.选择或者创建一个组织(new organization)。
4 G+ T( X* b3 ^; u& q) n- J }) E3.在该组织下创建一个项目(new project)。
5 W. a- {0 w1 ^* V: H 以上三步都是为了获取开发者(publisher)的token,获取token如下图:$ ]0 b' }' g) t
. I! V" C0 k, s! F6 v) d, P
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
/ f- T, y: d7 X( s( ?3 l& F
; J* Y) e, t( L6 c( R5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
- T1 s% e, t0 y2 x- Y三、项目搭建
5 A, J- C7 x$ v4 C$ ]# y. g$ ~$ w# c5 X1、项目初始化
; ^7 ~0 h1 }/ `" ?: ]- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
* J0 x: e T' S" f3 r2 H6 R
, ?0 P2 D" a- ]2、项目改造' k" Y6 z {5 ^
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
T; ]+ X# t, h9 k/ P1.将package.json改造成以下模样:! ^ L/ _* _" s% C3 b, P+ q3 D1 ]
{
"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包会失败。
# Q/ Z; f( I0 q( F! @3、编码7 Y! P9 }" H# P. E
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
8 X6 l/ |% x! P{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。( {2 W1 n( C9 r; ]) W3 w0 F
四、调试8 Q) B/ [1 `& N$ A
单纯的开发代码片段的话测试和调试都非常简单:
& U5 U# E! H0 z# r; F7 d- { t- 首先先自定义全局的code snippet。! [$ c0 h4 q9 d7 P3 x
0 q1 }; R: C2 O3 K- 选择新建全局代码片段文件。$ P5 ~; R' k |6 e
8 c9 u: z/ b. X6 o/ I7 h' P# ]- i' ^
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。 I- o. v; {8 E% V! r. o
- Y7 [* q% h7 A. @, D, E$ j( ^- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
, [( |* P" }9 b8 F# n- T
6 ]6 b2 T2 I1 g( N+ z 生成的代码片段如下:# i! P8 A$ M9 \- h( K) r6 I
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; 五、打包
6 i2 j6 I5 _! a X8 i4 @8 q 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
1 ?& {5 _8 C9 x0 f1 O# n六、发布 S) J5 H$ @4 V: p4 _2 P
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
( X$ f6 R* {' M' i, w
+ W# n2 r9 U* h
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~- W" q6 s ?6 F& M0 a
( u$ L- u# I* _5 L$ B七、结语: \% W. m! ~: X; [$ f! \
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |