一、前言. u* L! M- n P" f7 `' b
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。% L. _0 E9 c; {* d3 q7 N4 W
二、环境准备: _( N: c& W5 @$ a7 y) v
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g; I, P m# [2 E E$ P
三、开发者账号申请( X9 b! {- Q; p8 S( i- r z
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
2 H" v. s$ }% f- P1.注册并登录 Azure DevOps。* J2 t% b# M; I5 _$ z0 z, T
2.选择或者创建一个组织(new organization)。
}( t9 t6 a2 Y& L$ h- j4 @3.在该组织下创建一个项目(new project)。
, R1 c* n% I6 H5 a 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
! ?' ?" ~0 N- J. C
7 h6 }. ?( G1 i+ p' d
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。8 {6 }/ M: S) I8 a; C- {5 Z/ O% g
# d9 Y/ w. E. Q5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。1 p# }) n- ^. K# ^ B
三、项目搭建
; l. P: i! l8 z9 `$ O1、项目初始化
& I& C6 [3 }) U& r, C2 @7 D" {- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
7 N9 ?! H: p( _( @: [+ ~
+ w2 @. Z& P0 ^6 d
2、项目改造" C$ e. v* y3 U3 o5 W
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:( e. _; ?- B- _
1.将package.json改造成以下模样:
/ X$ g0 ^) \, Y. K/ t$ X2 d+ r, ~{
"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包会失败。( _( U& R% I( ?5 o5 b, D4 ?
3、编码
% z; V& R+ I# U( F+ c+ Z$ ? 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:+ ^8 u- _* v! n. F" 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。+ i6 f) Z7 k2 |, L; y- o( K
四、调试0 l6 S) p0 `" g" L, G
单纯的开发代码片段的话测试和调试都非常简单:
3 s, G4 q6 y- k! `" C- 首先先自定义全局的code snippet。" ], F1 Y4 i( \* C3 k: i. j2 f# T
) r7 J$ q. a+ Z: n8 B a- 选择新建全局代码片段文件。
( e- x* E+ f) {0 n) w/ P
) n1 B: ^8 C' e/ S3 x- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。& n: l- B# D& r
. }$ D! J8 L1 u# L9 @4 }- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。- a9 B/ _* C* H/ k+ G2 j3 O: ^# l
& Z$ l/ K& l! ^4 ]4 I' c, d9 V
生成的代码片段如下:
6 b/ V" Z2 {$ E: Y; K9 }/ |/ l& pimport 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; 五、打包
- S- a/ H. s7 U 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。% Z% u9 y! B* i# |- S$ r# b0 U) J8 x
六、发布# F3 `+ q9 j' f( I. C
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!# z8 S' u6 L/ @7 ~, r* C
- E2 T' O7 O( F' ~+ C" R
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
7 ~( Z+ n& F# F; S
; W; v1 e$ w& \9 h! |7 q3 ^七、结语
- n7 Q& n4 f- Y2 j. G h: O6 [ F vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |