一、前言
; P! F$ M4 l2 t* Y 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
. T2 t( X) g, X) z二、环境准备5 P7 `. O( F; Y3 p9 I7 a
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
! A$ c: a8 s) U8 m3 q( d0 Y 三、开发者账号申请7 Q# {6 e; Q! ?$ Q0 @6 E' ]) C
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。0 }$ ~$ N5 T' [0 j# [/ ~) }
1.注册并登录 Azure DevOps。
3 L/ f$ [$ ]3 C" U4 p2.选择或者创建一个组织(new organization)。
" B) ?6 c6 F9 [, W8 S0 O6 f# `/ h) n; U3.在该组织下创建一个项目(new project)。6 r9 B! |% _5 M9 X9 C, L1 ]( t
以上三步都是为了获取开发者(publisher)的token,获取token如下图:. b% l4 C7 N/ d9 ^
9 T3 T7 [+ `8 ^; @# j
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。# h+ F3 N; W6 G5 w
/ u3 f, T8 n6 n' S) C1 X" j3 t' s0 |: @5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
; u5 ~, m( U0 ]' @2 A! L三、项目搭建
- O9 q& h, U% R# E1、项目初始化. T" S! y6 E/ w
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。! e) U$ [; \ S/ |
" w: T/ O) M+ L; [5 ^: ?
2、项目改造7 L1 C1 D* L& S
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:6 R4 w) X* s; j7 I( W8 b+ [
1.将package.json改造成以下模样:
$ }( f$ ~" E9 l( q" f{
"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包会失败。
& j; H0 t" t j/ b3 U7 |# W! [3、编码
8 T5 c5 S0 B$ [8 j, O 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
1 W+ J M% _1 k2 ^; b{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
: [$ W. T4 Z9 m- _1 u四、调试
; u7 ]) Q7 j4 M# H3 ? 单纯的开发代码片段的话测试和调试都非常简单:2 D! F' }" x% c8 E) O
- 首先先自定义全局的code snippet。
2 S" p) \. V) |0 Q$ ~, c
e3 y( i. }! ~+ v" c4 l& U4 \! q0 @- 选择新建全局代码片段文件。* R! p- P$ [/ { O/ p6 B* I
+ `" E6 k& V" i$ O2 @5 s4 P9 v& ~- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。6 z# P# X) w4 P$ E6 D" e& a
$ L2 q. a1 F$ x% ?$ K- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
+ w+ \+ E3 r( C2 J" U# _
7 K4 M m% |5 v, I! E! | 生成的代码片段如下:0 Y& t$ |- ~* P. s
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; 五、打包
5 \2 l- V/ K2 j# ]1 p# r, u. `9 l 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。( n: v# T5 p& k- \3 t0 A; F* R
六、发布
5 w0 N ?9 T/ h p7 g% V 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
( q* w7 n i' b
' {/ T' v6 j2 F
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~2 m2 t2 Q/ F- K7 ^1 |2 L" T5 S
3 b( f, Y9 s4 g2 \3 p% `. G3 b
七、结语
( P+ U/ O% H6 d vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |