一、前言
7 F6 |5 ^/ x& T$ k+ X0 G) s 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
6 @& {$ A" c8 M8 V1 U- ~- |二、环境准备$ g0 o/ M# T% T& T: ^" P& _, ?
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
/ s# F7 x6 c2 q9 c 三、开发者账号申请. }. ~' m* W& e$ F/ m: X
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。: k# ~4 J( \9 Q6 A% N& @8 }6 g
1.注册并登录 Azure DevOps。3 h! C: M. O6 C. `/ `! a+ J' A5 K
2.选择或者创建一个组织(new organization)。9 B3 R0 o) ` {( z& l; Q& e
3.在该组织下创建一个项目(new project)。, `" p7 i. Y0 Q. k
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
X- [- w2 g, [ N4 I# s1 K( V
3 q; V) ? S/ \& e, D4 O3 D# {
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。/ Q: c' o: e9 W, x* ^
& _* e# a8 J& Q7 e8 U2 n, y5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。9 A0 z$ I+ H' G) V
三、项目搭建
. h4 {: f; @) T0 f- v8 V1、项目初始化# K% ?; v5 }$ c, H
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。; E( U& S: \3 j
4 T. g5 T: Z9 b2、项目改造: @( \2 C3 D% Q2 p* ~8 O; \
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:) V* k2 v m' k- k6 ~' p3 v
1.将package.json改造成以下模样:
5 }, C8 y( f( A# u4 x{
"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包会失败。3 V/ z: {% [6 P
3、编码
* ]9 E( a& }/ w9 l e, x 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
+ d8 f7 l, Q! F8 Q& s; s u+ 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。# ?: t% c- n. g6 F' [/ D
四、调试
: _# A4 Q5 Y$ |1 s7 t 单纯的开发代码片段的话测试和调试都非常简单:# O2 w+ e1 u* r* S
- 首先先自定义全局的code snippet。
: R% j' U# D9 V8 b9 p$ A
0 {# W6 J7 b' k6 ^( ^; a2 D# }( b- 选择新建全局代码片段文件。" E* o! w" I9 a1 t7 Q. j* `1 f# L
" {3 I! @8 E( h7 G; g
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。# m2 X7 \* B4 M2 f- |9 @
5 B( ]& w1 Z' J# z1 ~' g( G3 Q- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
0 A; p$ C9 |! p- M7 l% E
1 V( R Q7 G0 F 生成的代码片段如下:
9 H H% r- G3 A+ P' { q5 K% oimport 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 X, _: `2 R T- V w 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
) f, C+ N& u L5 ~% c六、发布
( K! X% j1 y7 p; R/ u 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
! i% f/ i9 G2 r
2 J" O5 L# g, A' d6 c7 ] I; g3 q 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
* J; Z3 W$ M: V, A! R( O+ f
8 w" F" a4 A* i6 o6 ~7 W( f- ?. i七、结语: Y* c* x) a8 P8 o/ S s+ M. e8 V
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |