一、前言 f2 i/ B2 I, |; o6 z
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。7 A, u$ Z) j0 N j/ [: Y
二、环境准备
* R2 J6 a7 n8 T! }% j, z" d7 H; D- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g$ @$ R( }% J: S: p; R! U- I
三、开发者账号申请
7 T9 _# C d: b% h9 h/ j 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。, M2 q) V6 N5 y% H/ S& [1 X) o W
1.注册并登录 Azure DevOps。, b F: Y0 Z9 j/ {$ ]
2.选择或者创建一个组织(new organization)。
+ E1 X& t! H& j7 C+ Z3.在该组织下创建一个项目(new project)。
) W% _3 h# m- ]/ |& f$ T! Q- f 以上三步都是为了获取开发者(publisher)的token,获取token如下图:% L& Q8 i9 G2 B3 P t. V( Z9 {
" W& c, K* J! y ?5 }4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
6 \) |- J8 o* s; u. K/ A1 _
" `& `! \! J: x
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。0 z6 C; z8 L/ J, ]
三、项目搭建6 J8 P" O9 n4 e# q7 P2 n s O- c
1、项目初始化 o% s% v' [4 e
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
1 m4 r+ u, m4 f. ` ]3 _2 d
3 N0 e- A4 ~2 ~/ j
2、项目改造, y, K) R) l5 U; x6 G3 l, E) S, R9 V' j
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
7 V, b2 a% P8 d1 U% ]5 ]1.将package.json改造成以下模样:
0 i2 a6 z( ~9 T$ o{
"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包会失败。
3 y5 t1 C& ^" Q, n( ^3、编码
/ i4 ^. q$ \! Q ^% F; N7 ] 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
# ]* g$ v1 S, P{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
# c. X) ]* P+ k7 X( a四、调试
% _/ E- n/ a- K, o 单纯的开发代码片段的话测试和调试都非常简单:
0 _2 x# I5 D# ]+ O- 首先先自定义全局的code snippet。
2 B" I8 ?; P+ Y2 ~8 e. M4 M8 t
' m& n @6 B3 J {1 r" Z# Z: u
- 选择新建全局代码片段文件。
' C4 ~3 s2 @5 L! b& `9 N p
4 l( v/ L$ e; [5 R5 u% D3 |/ x4 v- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
9 [ B5 X8 b% }. T$ H1 y
* }- H% t4 V+ Q, L9 t1 g- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。% N6 `( @* ~0 x! O- j# h5 I: |
6 A3 _! ?! [2 E5 H' H& P
生成的代码片段如下:! ~; p( c/ ]/ Z- f/ A
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; 五、打包, {4 W! u* Y+ r7 j- z, j+ t! e
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。* A' R3 H1 K2 {: p" @9 H/ ]6 r' m
六、发布- B3 P/ Z* Y. v, [4 F* T8 x
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!' Q: t/ C0 r8 n1 \1 k, d+ l
4 c% A3 j2 m" p) q
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
3 J7 O0 u7 ^4 b6 K
$ E# [$ [! e$ R2 p
七、结语$ Q- E8 n2 w* d( X+ S7 k5 X
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |