一、前言 % I8 ^9 e2 k7 M1 r" v9 c3 |: ?2 o
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。! B" z8 Q9 S& b/ W
二、环境准备 # P# t2 O. h) X" z# A( {
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
7 Z( X& D/ D( F+ o4 ]. } 三、开发者账号申请
7 D" Z4 b. o( U$ _$ D 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。; P) O3 Z' T$ q- b& V' H3 g6 ?& s9 t
1.注册并登录 Azure DevOps 。2 O9 a% A/ S) F2 |/ }
2.选择或者创建一个组织(new organization)。
8 o9 X- \) D5 d* P m- V0 ] 3.在该组织下创建一个项目(new project)。
) b% m/ i" e; B) v6 d- } 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
e8 }% H6 b% ^
?) t: `) J# n, A+ m
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。7 R- L4 X. }9 n1 N' G
) |% C, T5 R- p) n, e1 |1 }
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
- `" l8 \9 b! j; w" s# e, F9 J 三、项目搭建 + C& g# Y' K7 k: w# _' J1 _& h7 _
1、项目初始化
1 t2 G( j3 d. X7 |& S 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。3 x% Y( l- w9 T& K
0 c% F/ e, T- T9 ` 2、项目改造 # H& ^ H/ L; D# X. A
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:# W% O9 l7 R+ R9 b( R
1.将package.json改造成以下模样:7 v* O4 H- i3 d; @5 z( V6 ?
{
"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包会失败。
% P! ~( P: Y; d* F* z 3、编码 - J8 Y2 R: u, z1 z9 d' c
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:6 t K+ P ~: l& M) 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
9 _/ G0 d- g2 d9 c8 s! u9 N 四、调试
1 K8 _5 J+ ^* S3 P) u8 ~4 v- Y7 K 单纯的开发代码片段的话测试和调试都非常简单:8 u* X' E& _3 w- U, v1 R) Y2 D; ^
首先先自定义全局的code snippet。
" s, p/ B( Q8 M
% L0 M( |, ^" {$ t% j$ c8 c8 j% t: A 选择新建全局代码片段文件。
& k2 `/ j' f n
6 r- H) j0 x1 u/ R 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。2 p6 o4 Q7 v! y: E1 H) k* q6 x
" ?/ l3 J: l/ x, v. h4 B! b8 E command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
) n& y0 w; h+ Y3 z, S& K
$ V4 N; D8 D' S& s$ v 生成的代码片段如下:$ K6 e: L& ~3 e" 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;五、打包
$ U& l' s/ D) ?* I 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。2 [8 ^/ C$ r3 D1 F* l6 @- Q* J
六、发布 4 W# M$ _7 S; N& E) j
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!. F* J+ A/ o+ c
( _* B& i8 @8 L, y5 s
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
' Q8 c6 y* O' Q# K7 S
1 z# v' X6 T, E' `* x
七、结语 6 Y/ k! \9 X& C: e9 G$ t6 \
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。