一、前言3 l3 `# u/ ~; V. z0 T
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。* t; S: M( O- k1 r+ u {, ~
二、环境准备
: _ w' b6 e0 H! a6 I- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g4 s. z/ K2 E3 b- z- r, B
三、开发者账号申请
3 V+ a# J, D$ d, s 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
2 L$ y8 Y I$ J* m6 W- V! j; G1.注册并登录 Azure DevOps。
, S" _/ r. i h( Q2.选择或者创建一个组织(new organization)。' t2 K; ^4 T# e
3.在该组织下创建一个项目(new project)。4 t0 z x: O3 h3 C( K8 \0 o \
以上三步都是为了获取开发者(publisher)的token,获取token如下图:: R8 x4 g; I) Z- B
2 {% y8 W6 l1 ]* c2 @) m4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
3 D6 l2 W3 Q8 \% W$ i o, C
" q$ x+ z- m0 B7 c3 f5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
/ t4 w9 O t' h0 I三、项目搭建$ ~% h0 b) Z% D' B4 }
1、项目初始化
) W, F( ^4 O+ B4 @0 x- L$ a0 `- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
4 _ W4 K! J- z
$ c8 J# c# {" b0 S7 _) _
2、项目改造9 Y# Y" X3 g7 e
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:* G% K; L" E& P. M# i
1.将package.json改造成以下模样:
4 ]9 A3 c% ~' O, }6 L7 K! S{
"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包会失败。
- @& ?) c, ~" H0 ~* E0 R( X3、编码
K! r- r+ N7 x# C" n) [ 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
" E- `% s5 \8 J; N/ R{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
( B4 z. `- d1 {& h四、调试( I& i) A1 F* [- }( c$ m0 n0 ~
单纯的开发代码片段的话测试和调试都非常简单:9 g# j& @- |( l# y b+ N. P
- 首先先自定义全局的code snippet。
3 N% L; c; q/ C% [( f. `1 t# Z8 c
$ g; C. u# S* d, q
- 选择新建全局代码片段文件。7 n8 t' k( T& z) i! \
) c$ i% A6 s' b8 J7 U. m5 J- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。0 d) E$ `7 ?4 B0 N1 Q
# `4 }0 {5 J8 t( W3 X
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
8 Y# P4 F( w# o& K# U- U
% a+ i! K: z" u. l
生成的代码片段如下:4 |% I$ y9 U. ?
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; 五、打包' O' Z# f* \( v8 a" K0 {3 a o5 P
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
. u/ w+ B4 D# l7 {5 ^- o六、发布; w% U+ E/ U) H1 d' f8 L, Y
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件! N+ w6 ]) L1 l/ Y1 p' p
! [, Z2 \1 t7 E 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~! A3 P6 N3 a+ W9 |
( S# ?6 g: O# p" I4 E七、结语
$ N5 S0 G: e6 U6 ~$ } vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |