一、前言
0 L6 z. K/ n5 j4 P$ c) P 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。2 y$ }) a& j$ s- T1 Y; Q
二、环境准备
9 c# h6 _$ g; A8 g7 R1 V+ l/ n- p- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g9 \# r8 s: h- p
三、开发者账号申请' c G4 M. A" [+ l1 B+ D) P8 |
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
! G6 O1 D4 L0 H5 P+ C( y1.注册并登录 Azure DevOps。
; ]8 z7 P. [! [% e2.选择或者创建一个组织(new organization)。/ o1 T0 p u4 \" C2 p
3.在该组织下创建一个项目(new project)。% D2 _1 A( D3 E5 I7 d# W
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
3 l' o$ k0 W: j6 l8 Q7 s8 h, U Y
& s+ T! }. L5 f
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。8 [& }" H3 c. n# q( |4 n. F1 S7 h
% j; n# ?6 c/ D- Y- R1 K2 L& t
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
+ |2 e# v' }( h* e. F2 i4 e8 C三、项目搭建* l: @) z* ^- U# \( ?, O" {4 H
1、项目初始化
3 [2 i5 \8 z: ^# ^$ G- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。, |) ?, k1 m- G
2 g8 u4 B5 d' T% D0 u7 n3 H L2、项目改造" R$ l9 J' f$ {5 ~' c0 y
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:) I+ t8 e- s9 {3 m. z) U, B- o) A
1.将package.json改造成以下模样:2 Q) y0 _1 _: y) T$ T% W R" `
{
"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包会失败。- r/ Z& n( v E6 P3 ?0 Y* B7 _
3、编码
, Y6 T' W8 A' J+ k( P 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
9 C4 j" Y+ V# o& V1 U{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。3 J5 q9 Q0 R) V3 r: Z
四、调试
9 z: S# m+ _" J! F 单纯的开发代码片段的话测试和调试都非常简单:. J8 H4 y' Q" L4 [* }) O9 y9 O
- 首先先自定义全局的code snippet。0 q# R3 v! L2 ]9 ]6 ?; w# l
3 R6 X6 W. U' r+ ?3 c5 G- 选择新建全局代码片段文件。
" V- `7 W. F, n3 R; h5 o% i) k: m' L
+ |+ h, R2 h$ G0 m' W- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。* `1 g, g$ j. K
Y. s9 V( V6 l7 ]
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
, c: k) }$ |2 k: s3 S( J& |
4 K- }( F/ w7 k4 ^! T 生成的代码片段如下: A8 S. x0 V/ |' O' K2 f R
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; 五、打包 E6 ?" J. h! D- ~( a
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
2 j7 c" Y1 e" ^7 G5 S六、发布
% l" @) c! S$ a* c6 u+ } 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
2 i4 o9 T N! \1 Y
! j/ {# h3 G, `) Y6 U: R 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
8 P: b5 z. U5 q; S
7 x1 W( o* x; ] }; B% ]
七、结语! n3 d8 J* C) o+ x& x. c
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |