一、前言4 ]- F8 h) Y- b S; L1 R* E5 f
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
# W% J* b* X/ w1 u# G6 g: t二、环境准备
+ ?# Y$ D3 z$ m2 ]/ [$ N- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
- N7 {' i& j! i" n x* i% W( a+ S! Z0 W V 三、开发者账号申请6 m, @. c* M+ M7 W. @) G6 l
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
) Z3 S |, n/ Y# s# q1.注册并登录 Azure DevOps。( M/ j9 G2 {* u# B8 K" D4 s8 Y
2.选择或者创建一个组织(new organization)。6 l, n' r/ l' k( t
3.在该组织下创建一个项目(new project)。
% N Z( r6 V7 q/ g 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
* `: R, | I) @5 y
j0 M1 R5 m: a& r, H8 v# a
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
8 Z! B9 o' Y: a$ P) k% w
$ ^, ?( B% v% i8 u& V# i5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
4 a9 h1 q: b) }! V& Z; @$ Y3 {三、项目搭建
1 {. }. P+ Z; Y. q1、项目初始化; b* D8 c* {& u+ ^% M* t
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。+ h/ D0 d9 I1 r# j3 U( V
) I# i5 p- @ c; B* h% W4 L1 n2、项目改造* H; j' A: P# v" R( I
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
. |( Q+ M3 I: ]& |& z+ F o1.将package.json改造成以下模样:# d2 S) r" b7 h& I4 Q+ y7 Y
{
"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 f' J; D r9 [5 k. z8 [% A4 _0 K3、编码5 K8 S* R& `9 H
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
+ B$ I0 m& N# P) S8 K: y6 g{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。; A7 S1 S- S# H! b, X/ [
四、调试/ B# A' w- a- o5 M" U
单纯的开发代码片段的话测试和调试都非常简单:- s2 A$ Y) T- ~8 n. A
- 首先先自定义全局的code snippet。
' q% b$ R( x8 w9 X
. v+ d5 G& N0 t% p# W- 选择新建全局代码片段文件。
( @9 {6 ]7 e8 E4 @( U
* s% x [6 X* |% g- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。8 @- A) Z4 }& W& f& [" j
' C: Y. P+ C' }# z7 e% d- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
% d! a% k) U* }$ S0 U* @% ~
. j4 L7 `: ~: L$ f1 ?$ {8 |
生成的代码片段如下:+ }( a8 V1 _7 p, Z
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; 五、打包
! [* w0 _% Z( y4 h5 L0 D" p) t 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。' `& q- o* } I7 {0 i! v
六、发布
3 \6 C# `# I5 b/ t. _5 B 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
0 {/ D1 W1 v: j
8 x' W- U7 K0 v; E9 b0 L 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~% g, C) O2 U% W+ O1 z5 Z
* A1 Y+ s6 v- Z
七、结语, n( W7 s% C. [" ~5 f8 y
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |