一、前言
8 {* M, J# g/ w3 P V) C 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。' T2 f9 t7 o: u+ I) Z/ H
二、环境准备
7 h+ F4 Y2 G) C+ `% X- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
" |4 t" W4 {7 W' P5 S: t5 x 三、开发者账号申请$ p H, r( z J: Z2 f* P0 h
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
: c p5 C2 ]/ K; f$ `1.注册并登录 Azure DevOps。
; G& q9 ?' B& E' C2.选择或者创建一个组织(new organization)。$ b5 _- d6 }2 R$ _$ V
3.在该组织下创建一个项目(new project)。! [& ]6 Y5 w& N- B Q0 I: W' x0 s8 D
以上三步都是为了获取开发者(publisher)的token,获取token如下图:4 X* L5 E1 c2 S$ y7 w
( R1 G1 L3 h, [4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
8 y0 A! U8 t8 S: Z% A4 b& A
8 P/ f$ U8 _1 D7 A0 I5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
( u# [, T& [# i, E% k0 R z三、项目搭建" s2 E% E% i$ d2 u4 j
1、项目初始化
, D9 O$ h# g- j. I- j: s! D! k ^- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。* g' s( G& }- k1 X* A9 L% V
$ N4 S3 m1 I( v! c2、项目改造' ?8 I1 M! C4 ?2 @* l' T
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
# ?7 ^5 {& j" ^7 c; D; V1.将package.json改造成以下模样:
0 z4 ]' p' f/ V- N, H" @{
"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包会失败。6 |8 |) y( }' v
3、编码
X' d4 P. z" U# o) [3 x 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
8 F- b8 z# |' c4 Y! i) |* `{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
' [( Z4 d+ o; |6 d- s/ {四、调试+ m6 S! F/ Y9 @( ]' ]/ L4 S/ D
单纯的开发代码片段的话测试和调试都非常简单:0 L) `, O6 m! _' P( L
- 首先先自定义全局的code snippet。
. W2 d5 s- B, H4 \' D
$ k% A3 z) G5 }1 Q! O% B- 选择新建全局代码片段文件。
* Z. X B: }' ]( S( k. K
) J7 L! l3 M9 M; J6 J- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。- j6 K0 q/ Q" Y1 E! K/ Z. ^
+ J+ g$ m9 u: x9 m6 S- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
# y8 l" c/ ~ H$ @
& H( g; n; R: Y, R
生成的代码片段如下:3 O0 R! H* |' n$ [# a
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; 五、打包
4 E! G1 M7 d9 r) Q9 p 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
+ x2 t" c( |2 V ^( m六、发布. e8 D( ^+ }5 b( P5 ], _6 v# c
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!% j# E6 R. ^3 l
2 H" {& h& C4 O0 |0 N: Q- m 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
! @& y& s, W) o# `- j7 O& D$ B/ l
1 j3 [# o! t! ?9 l七、结语2 D2 h; T/ d& J" t
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |