一、前言2 y# S, d" I4 }$ G
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。- p# R: P) i% F9 q0 v
二、环境准备. f% ^. u9 ~% e7 E1 }& T
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
; F* O, x: E6 w; m. x7 {$ t 三、开发者账号申请
1 K# R* h$ X0 y8 T ~3 h 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
6 y( A' S& u) {( H8 T& M3 d" [1.注册并登录 Azure DevOps。* {6 r; |3 q( M; H
2.选择或者创建一个组织(new organization)。
3 M( i# V" d5 A/ p3.在该组织下创建一个项目(new project)。; g; v9 B2 V! J; d- K" v# T
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
: I& ?2 @5 W. d P' K8 [/ R
* ^: ]# N) S5 ~3 B; n4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。) P: _( o N* N" \8 G6 M' N
7 D! {( S( R# B+ N x' Q5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。8 K' v. i# O4 f
三、项目搭建9 ]( F" T$ ?$ Q# |9 V+ P+ F
1、项目初始化: o# M: E) n6 K& q+ g6 S8 } d
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。! g; T4 I" I2 C" d" X0 P- w& m4 @
; {3 N3 ^& X# ~/ ` Y+ m; D3 \ X2、项目改造2 J5 g% m, {: V' R" p2 ^5 l
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:3 E/ h0 }$ B4 C1 a C: c
1.将package.json改造成以下模样:" K* }8 Z$ 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包会失败。* }" }4 B6 }' U
3、编码
, s4 b. q2 w% H 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:2 B$ G9 p7 R0 l0 @# Q# X( a
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。" ~- C, h, I9 k. s4 [
四、调试
0 i; t$ Z: c) y* e 单纯的开发代码片段的话测试和调试都非常简单:
( [4 B& I0 M+ Q; g( }8 m. ^" d0 C- 首先先自定义全局的code snippet。! E6 o3 }; x$ J E" b
% P2 c$ y ?7 ]/ @- 选择新建全局代码片段文件。+ U# e0 K% l) O V
( A* \' u0 C" [# h- m- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。4 }( O0 S& e+ r3 C% J
& S( `9 N- a& G* {, k9 `- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。. C" `3 c8 O1 f
6 z+ v- L3 W0 p6 l 生成的代码片段如下:$ Y n" h+ u" O4 ?0 [
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; 五、打包6 v; ^" p/ M% y
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
+ c) q# x7 g2 y1 R六、发布2 q2 ?+ ?1 z( ]
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!" b5 C0 V. U) z6 V i. I
: o( s' ]: }0 w% }8 z8 e9 V 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~& g2 N$ K1 Q: y$ c
6 d5 c7 M ^" I0 H2 Y' S
七、结语# f: I7 P; c. U0 \( b
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |