一、前言
* @6 C o4 z$ ?( x8 w8 o+ N 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。1 e6 b% I7 `! G3 ?
二、环境准备4 P6 i, x7 R3 ^1 ^ `8 Q
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g* Z& y- Z/ z6 `. E8 w
三、开发者账号申请$ J E3 `! P2 U! d
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。" B: X, o9 @4 ~# X5 ?
1.注册并登录 Azure DevOps。
o; P7 e5 b( L0 I9 V( c2.选择或者创建一个组织(new organization)。6 {3 i0 d: l/ N1 H3 Y$ Z/ I. z
3.在该组织下创建一个项目(new project)。
3 s7 l( y) y( D- [ 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
l: H6 `. N1 ^2 k# E, m& n
, ?, V( G8 F& Y1 z' U/ C. e; @4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。8 O9 a) a6 Q/ n
2 B0 R- `( t. G, P# m i5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。) d. b/ E' l8 c% d E& A8 s
三、项目搭建7 J% q& Q: _3 [, R, c
1、项目初始化: X8 e: w" p J4 G) ~/ Q
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
/ c7 ?( z0 d. v j
, `" a/ p. j, _) u" O* |* k2 s
2、项目改造
. l% [: _8 e2 x. C; o v 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:/ b9 x% t/ s: S
1.将package.json改造成以下模样:
6 A/ _! p1 m! @2 i M{
"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( ]' e2 @( a' ]! X3、编码) D) y; k4 o9 M$ L- E
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:8 I, u+ a1 K: W1 J z
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
: n& D. @# \8 n+ Q V2 r; z四、调试
3 J6 H2 ?. P/ D8 j! N5 { 单纯的开发代码片段的话测试和调试都非常简单:& E* N I' y" t& }, t$ h Q
- 首先先自定义全局的code snippet。- D" X2 j& g; H- N9 B0 h# B4 f
7 o+ h/ l# k8 _$ w: t1 D2 P/ a
- 选择新建全局代码片段文件。
( ?. T1 p/ ~$ b
: T+ [! X, p4 |4 Q3 [5 u
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。2 |$ Y! s& r7 @) Z2 X
' g- Q1 b* a) F, b/ M9 b" Z- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。0 R7 B8 P% E$ ~ C7 c
/ G6 ]0 d+ w* t( O- H 生成的代码片段如下:
! I$ f) ?' h) m( k7 Mimport 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; 五、打包3 d$ f9 V& l" K$ x+ L
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。! h; a& G n4 O# S
六、发布
. ?( k) P) q9 k( t) I7 Y# a 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!8 K. s( l: ?" C4 I- c
. a: Y; j* k* C- E
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
) I9 v* P/ k* O" S: Y$ E
4 a8 c. d6 ]7 h* T8 p# o
七、结语
0 G+ i- T' D+ }; z vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |