一、前言# }$ o% w. @ s' M2 p: r
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
1 E# G$ h7 A# y二、环境准备
, m% n/ z! m/ M* a- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
* m6 f! J, d" _5 h# ^/ M0 m; ?% h+ d8 J 三、开发者账号申请! B* N% A$ m/ S6 o
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。4 c3 i2 w2 p$ v+ G# x
1.注册并登录 Azure DevOps。
1 O! _) B/ B$ Z) ^4 R0 `7 e2.选择或者创建一个组织(new organization)。
7 s3 ]" V8 C3 p' s( y3.在该组织下创建一个项目(new project)。
4 n1 Z" v7 {" b' W 以上三步都是为了获取开发者(publisher)的token,获取token如下图:4 D3 s7 D% v1 R
* T! t0 P$ Y& \9 R0 K! ?" Z4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
+ D4 I# f. g7 w6 ^! }
1 O- y8 }; e* k5 H
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。" N8 i. r) {- F- e) Q4 ?; @
三、项目搭建
8 s% j+ h; o3 R2 H# t# X* i3 c( O1、项目初始化1 j1 T) _/ O/ P/ G
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
6 D! t6 E& o' a1 i6 a7 L- s
$ [- C. u3 R) e( d! @. O
2、项目改造! `4 {* d7 z) z, w e( e
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
- |+ d4 f# t' `8 n7 w' ^/ T2 {1.将package.json改造成以下模样:
+ @. U; r& F, P3 ]* d; u9 U{
"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包会失败。
' R2 q, N2 w4 p1 C3、编码5 C8 ]: X2 Q3 {' r) H* n; Z+ E
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
. M, P& w+ t9 m7 d- @4 y{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
& M$ ]7 i: M8 q( B z四、调试
6 u; L; Z# p0 \* y, J: q 单纯的开发代码片段的话测试和调试都非常简单:$ E: t. N: s" R7 s# ~8 L$ V
- 首先先自定义全局的code snippet。
N* s/ A- |% |: O' H! V
. d- _0 h* C# R# k; `0 ^6 ^5 e# ]
- 选择新建全局代码片段文件。
- a& d) N0 }! Y9 _
! S6 [! ~; n# q% M
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。4 b# e% K1 x. z1 g& w5 R Q, C% e
+ f/ i5 Y3 W( o+ [
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
. h! \: h' S$ r! c* j
. T4 ?& l, ?" ^
生成的代码片段如下:1 U% s4 w8 O5 ]
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; 五、打包
' G9 |9 z" p' I' l. [' n2 M 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。$ T- G ^! P2 q; H2 E
六、发布( e" s& U% w; ]( w) z
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
$ `; c( @/ ?3 x- `, J
6 {9 W1 A1 j @- C r6 G" o
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
* h( `! Z, e+ y7 n( |, `4 {
* ?5 |' F, @/ F/ e/ v* u9 ^* f0 A七、结语1 h, k7 i' }0 f0 m3 E6 a
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |