一、前言
+ N; Z* e; T/ u. ] 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
4 ?4 I- k& z# ~* l9 Q二、环境准备' c" R% A9 Q" u) N ^0 L/ U( j
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g, n; A3 y. f8 {/ b; z. g8 K
三、开发者账号申请: T( X; U1 X b% j
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
& b; ^( V/ K7 d& [% M1.注册并登录 Azure DevOps。
2 m* n' w s- G2.选择或者创建一个组织(new organization)。
1 F* O3 K' c6 X8 Y; D6 V3.在该组织下创建一个项目(new project)。
* }% m9 k1 X; ?' P& \+ j 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
0 t2 c8 {1 g T4 L( \3 q: l0 Z" y
1 w/ o" y h2 q8 ^" S" B4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
- E. B* v4 Z- S( o: I
; K- U0 P* _' ?) p( A" l: b0 z
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。% |0 ~6 \, q- i) L- `
三、项目搭建4 ?! I! R, I2 L7 s
1、项目初始化
, D* t1 B( u- \8 e, o- D6 x) Q- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。4 d. O4 p% d! [; s5 T. d, D
' e9 U( c. y. H8 c
2、项目改造
( q; Q( P% ]$ o8 l; I+ g2 y/ [5 } 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:# v/ [1 @6 ^9 B
1.将package.json改造成以下模样:
( @, I) ]. X$ d" G{
"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包会失败。& J9 u7 y, w- l3 u; U. G8 m- ~
3、编码
9 X* L9 H" a# o# [ D" G 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
; T7 Q! r0 n) o; h! j9 G+ n3 Q6 |1 y, |# h{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
' H4 z4 d& J; s6 J. e, l四、调试' E/ [, [& r5 Q' n
单纯的开发代码片段的话测试和调试都非常简单:, D* y9 y% k7 b# f5 |
- 首先先自定义全局的code snippet。% H8 B8 `9 o7 |1 i
8 z7 u% d5 `# o+ k0 p8 |' G
- 选择新建全局代码片段文件。% d9 R6 t- ~0 b9 p$ F' }; t
' v r& Y5 E1 U6 W1 ?" a; ]- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
: _2 v) E! ~! |2 d% o+ i
; \* `/ P% m/ L, r4 q- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
% e; s: Q8 C+ C# {) `" H7 l; j
0 Y+ ^0 C I6 q7 s, ]* \ 生成的代码片段如下:
& e8 r/ d. |+ v$ p3 Rimport 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; 五、打包: h/ T$ a1 W, C7 r4 g- p Y
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。* B3 ~* r' V# @* Q$ Z; v, j
六、发布
6 M- m+ \( ~# T) g+ S0 e" m0 l& g3 d 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
1 m7 x" Y2 \. E8 t
' n, u# q. W+ d 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~% {: ]. H3 H/ v) Z. b% u
7 ]( a4 i: L& B0 H# g
七、结语
. I8 i" `2 |) H8 s vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |