一、前言
]" c, K6 G+ \3 G2 ?" J) \, g# [- e 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
" W5 m/ X: M" A( Z$ ?; a二、环境准备
! `/ @, b% p4 |# L$ G2 L A6 W- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g6 w. T5 _" f; h: @4 O$ F' T1 [
三、开发者账号申请
0 b% v" O2 A% ~! p5 u& I& [ k 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。- |. s3 Z2 d+ `% f% M w6 a' g& [
1.注册并登录 Azure DevOps。8 ~# H9 {2 s5 T- w9 S% J
2.选择或者创建一个组织(new organization)。, q4 y g; S# Y5 b( R
3.在该组织下创建一个项目(new project)。
, _& |: ^2 o* a/ g7 i9 U+ { 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
% T3 Q0 }8 a: y( u9 Z
' T! R E9 H8 i7 s; D4 R3 d
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
1 n2 ]6 y& D: Z3 f
) C$ M9 I& R. V8 V4 o1 ^# F' G
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。* F+ e" B' T# T3 T! J3 `+ k- B# q
三、项目搭建
& Y3 q+ Y; T3 \, C! @& B8 m1、项目初始化, v0 Z7 `% P4 e
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。3 E6 ?, X8 U# R' {5 a' Y- V: o
7 [$ v7 H, d! y5 M9 n7 x7 P2、项目改造
- J7 g- ~: ?0 M3 G/ r 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:9 u' A) h8 T" x) y/ d
1.将package.json改造成以下模样:
7 C/ [6 K4 N/ U+ c3 @$ o$ n{
"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包会失败。
# n& e7 l9 q% ?$ i( p2 L3、编码# ^/ m6 h% u1 f% }0 d
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:; J1 e: f$ `% |- a6 q4 \) 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。6 d; T6 ~! b( l# F1 p
四、调试
/ I' f8 n+ M9 B+ w R6 T$ g' C 单纯的开发代码片段的话测试和调试都非常简单:. |2 @: G; o& ~/ ?0 ^) i2 d, t \
- 首先先自定义全局的code snippet。
6 h3 N6 X3 |+ w5 k
/ ]; T& t6 S+ f' ]- 选择新建全局代码片段文件。
/ p4 b) }$ b7 N$ K7 e
3 |- \8 b) m/ K: L4 [! M
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。( ~, F1 Z# ?' t
* b% f. d. n! W7 [( H" ?0 ~- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
2 [& a5 K# C* S8 q
$ I! b. C4 U# A' n 生成的代码片段如下:1 n) f# y p% d0 T i5 t1 }
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' p+ A. n" B; m- _ z
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
) p' u# |3 b& `5 K# G6 X! j1 l六、发布
8 P6 _+ }6 ~9 S; H$ l! z1 v 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
0 a, W5 i$ z: S- `5 u+ u
) |5 V, s( N( R: F& }
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
, ?! D L h6 Q8 F+ q
& t+ G) H: @8 a! P( Z) P) W+ _
七、结语
( A' I8 X: g* h7 s vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |