一、前言2 H$ s# Z- n1 R: V& ^8 @5 c
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。; p1 D& g+ m: l+ V$ r
二、环境准备6 @" Z/ V0 d/ R# C. L
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g# l: z3 r C5 _+ _7 g, a& L8 Q. \4 S
三、开发者账号申请2 u/ }( H+ V+ k* Q$ a/ B% O
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。) w/ ?. j* W5 i! ]
1.注册并登录 Azure DevOps。
, j3 o+ J$ K- G; W: ~) J2.选择或者创建一个组织(new organization)。1 Q' @/ p0 j* o+ y- l
3.在该组织下创建一个项目(new project)。+ ~* r3 S0 N2 b- p, Q; d
以上三步都是为了获取开发者(publisher)的token,获取token如下图:! N% y7 J) I0 M
1 g) b' B, K( e" F1 v" @7 V5 f% `
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。5 S3 C$ u. v' i! D4 [$ l
% N/ R! w" ^# d$ k" U V7 b
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。4 ]( b+ y5 c) ?, p
三、项目搭建9 I x. A- L2 Q. @. b
1、项目初始化- N& i7 g- c9 h( }# h
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
' g! I: x. A! w8 H+ U
# S6 @, r' ?. S" p Z% Q/ G
2、项目改造6 a1 |; ~0 T6 E; \' E
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
8 u' l+ {: M- E6 G1.将package.json改造成以下模样:' h# B8 V3 ~" v
{
"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包会失败。
z: a- ~8 O, p- f# c; _ ?3、编码
) z: |; q @6 ]7 A 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
9 v o3 O" E, h# f. p2 ]{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
7 R* Q: E) d. g" ]# \* [四、调试; R7 x! p! P& J6 f. K
单纯的开发代码片段的话测试和调试都非常简单:' l2 U' ~! i( K0 A* @# W
- 首先先自定义全局的code snippet。
, H7 x; \4 y. a! F; |" d
. Q6 t7 O' P) j1 x5 ]# `- 选择新建全局代码片段文件。( X' h) F( ~0 r$ A
$ e" ^. h( w; L
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。/ ^! L7 D' W. T# Y
- k1 I3 [6 j4 x( P- @5 Z- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
4 u5 x: j7 |3 m" M2 A
* L) y( w2 O6 l5 `3 N7 g 生成的代码片段如下:
& U( [0 L! O( \ simport 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; 五、打包) v o$ a( F; p) `7 |: X2 U6 y6 o+ X
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。6 F/ f% C* g; o: |# X9 T3 E2 O
六、发布7 M9 p+ e/ j) M
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!; t: y1 \& S4 E/ S! x) ^, @7 U
9 b* M0 C' P, s7 p 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~, I- {* K3 K( t* _
9 K2 W3 @0 l! @! V& U4 n
七、结语
' S6 j+ y/ L: n, y vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |