一、前言8 Q0 @- M4 L, I1 w, G0 C
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。7 b0 T0 n5 {( B
二、环境准备: {; B2 p2 v' v" x1 V
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g, ~2 t% s7 ^0 r4 {+ c
三、开发者账号申请6 u. L8 v% V. U" Z% ^1 N) S
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。* Z% n- _1 T! L0 C _7 b6 @
1.注册并登录 Azure DevOps。
8 t$ c; d- G& s) D0 h2.选择或者创建一个组织(new organization)。: D3 K4 h1 z/ e
3.在该组织下创建一个项目(new project)。! P, H% M, u8 ]9 T
以上三步都是为了获取开发者(publisher)的token,获取token如下图:( P/ N' o9 d- F/ }4 l0 a
: i9 h. Q& I' F e4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
) Q$ [! L! B. G7 D W3 U
: K+ B* `; b. Y3 A. w5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。; C4 L8 V1 D+ K* W5 S9 T" a
三、项目搭建
, ^7 K, I, ~: `$ y* N8 ~1、项目初始化
$ h: P F" v; e+ P0 c% ^, W! ~+ Q- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。5 r0 |8 ^: F8 W& T% c2 R2 D
1 U% A2 Q; f" w
2、项目改造. X/ f9 h r) S- ?# i
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
j$ b4 X+ o" U+ D1.将package.json改造成以下模样:
: B) R: H8 H, a+ T. a! ~{
"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包会失败。
0 `& G$ c9 v1 f: R; F3 o* _3、编码7 {" G" {; b4 |4 N5 v/ K; o
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
2 r* r; n2 H* x2 V{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
- t. z! c$ E- ~% [, P, o四、调试
4 ^; `( E5 t; Z; N: h7 O* p 单纯的开发代码片段的话测试和调试都非常简单:
8 e" f h5 [2 u- 首先先自定义全局的code snippet。
" J- U" `" R0 T! ]$ R2 ~: X
# k& ^+ j" Y; e, f- 选择新建全局代码片段文件。& B* ~. J" @7 F! }9 b
m1 J. |5 L B; C$ `4 E+ \" H- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
, a. L6 ~0 q7 l& X
/ q* u5 s+ f* Z
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
8 z9 l1 ]# }6 v$ r! V, f
4 j2 S% M8 K$ f" z/ S* _
生成的代码片段如下:& c5 z/ e$ I8 |6 f. x' P
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; 五、打包1 F9 D7 R7 O) F; G! _% u( T7 k
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
$ c" F5 {0 K4 B, H% H六、发布# Q7 \, ?: a7 j9 U; V E' |. d
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
# E; p7 n# r+ v+ \" ~$ {9 C
9 S0 \4 l( l* b( b. i# ]
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
2 b+ L) N- x+ X; {% r
' N& n, O$ p9 R- I7 m
七、结语
( I$ |7 [5 ^8 p( A' V! ^0 L vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |