一、前言
$ I5 G/ C, }3 k/ I 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
" s% Y) R4 S! _4 @. U$ Q5 G, \二、环境准备 } Y. A& D6 D8 J; k4 K
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
$ K* _& q7 L. M/ d- u4 d9 G 三、开发者账号申请
; m1 R$ O2 W1 {5 c7 l 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
; Y3 R% ^! i5 p1.注册并登录 Azure DevOps。' a% ?2 p/ T% R4 q1 a
2.选择或者创建一个组织(new organization)。3 ]- F1 e) A8 t% h
3.在该组织下创建一个项目(new project)。/ _1 d0 I0 G- ] q w7 f
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
) H* f$ g8 K0 B) D& S3 u, l& D
% }) }5 L2 O, [& `* H
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。& S; ?# \( @2 p# P
& R4 U( ]: Y2 ]" ^; K% g+ {
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。 R/ }- M: G9 X: n; l' ]5 r
三、项目搭建# k) B% @% U. h& C2 C6 [
1、项目初始化
& N0 L" M" B: x# e- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
l3 Z# J$ H0 ~2 N1 d3 D z( n
8 {2 X! W2 O' J7 C2 j
2、项目改造( } f9 F, v% O! c! L7 u) n
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
. \/ ?2 v, j2 a+ X% O( x1.将package.json改造成以下模样:4 q5 r9 h, M3 `9 R' s* c( u
{
"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包会失败。
& E9 |9 O: I% q3 i( Z/ m3、编码+ y% F' T1 q: M% R" ~! e
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
/ U# O( T0 n6 { y6 ~* K{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
- E. ]! |& B+ W8 {1 D+ P四、调试
* M* ~. Y1 w r7 h9 { 单纯的开发代码片段的话测试和调试都非常简单:" o" K# P+ G- L
- 首先先自定义全局的code snippet。
~) {: `/ w8 X1 r' ?
$ s$ T4 ^( ?9 U9 [: n- 选择新建全局代码片段文件。4 j+ D* y" f' B' r
! b1 p$ R% Q ?- U% }' I
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。" }. y j) t0 d2 U, b
; {7 X3 M! u4 M" O5 \- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
1 c% R% ^7 R: f' C \1 R. O
7 ~7 K2 K: |4 F- ~1 s J. S1 Y; ?" ` 生成的代码片段如下:1 |$ \, {. q0 O
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; 五、打包( j& C! L0 n" A& r6 u
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
0 U- o" p# D% l' e六、发布
0 W& o8 H3 j" Z 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!2 C/ A5 {8 d0 Y/ a8 z' E
: E5 S) T* p$ `$ L, M2 ]4 D3 p
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
) H6 O: A3 n: _) R9 U p/ N
0 M* V+ Y7 F7 f C七、结语
7 G( L& ~- q: u/ n) f" C8 p. P$ a+ j vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |