一、前言! r$ H r+ y7 `) O: p9 u- K
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。- h8 e5 E; b% [7 _
二、环境准备" {2 T3 {- i( @
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g4 E# N/ k8 c) n+ }/ I
三、开发者账号申请- M9 k/ e$ I) }8 Y, R0 t
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
5 N( E& y: d$ l2 @5 e1.注册并登录 Azure DevOps。
% l, y5 F+ _. M6 t1 p2.选择或者创建一个组织(new organization)。* w, v ?5 m# N
3.在该组织下创建一个项目(new project)。" x+ t& V/ ]( y k
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
% |- g5 e+ P1 s9 `
' H/ _) e# F- K% _4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
# O+ s( F8 X$ N8 A3 l1 h" y2 m
# M! \& x8 g, _- e5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。8 O* h; f2 `# A- x
三、项目搭建
2 m8 G: P4 i7 E# `6 A4 Q7 d) a& e1、项目初始化
2 ?1 N& `3 f- s1 k" i7 E% Y6 f- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
& j* k! S+ U5 C$ @% ~. Q6 u- M5 X
: I9 i2 D3 u3 X9 Z4 S5 f2、项目改造
1 l9 k" k+ J% B, S% h g" m. \( O 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:- E) a2 ]* s6 P/ q' d% Y& T7 k$ P! }/ `
1.将package.json改造成以下模样:2 G+ N7 h1 V! j( t- j' t; v
{
"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包会失败。. b* d/ r9 S8 B8 a$ u
3、编码
# k2 y4 a" Q1 v- q X9 y6 } 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:$ t6 H1 N0 P O G/ N5 ~, w
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
3 \% S' K0 P! v四、调试7 W S$ `! O! g
单纯的开发代码片段的话测试和调试都非常简单:( b+ z0 p2 Y5 i7 y' i9 g, |
- 首先先自定义全局的code snippet。+ t' X7 ^ L8 O$ k/ g h8 e
9 g v, s1 T) ^! [. Z2 ^
- 选择新建全局代码片段文件。
! t) C' R1 i; h4 y/ a' @
1 |, u7 u2 X0 y' E6 @' K
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
! N6 a4 e$ U& j4 z
. {9 G! g+ q- ?6 L8 r7 M8 f! V
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
- v% D; {% T' b& K# h
9 W3 o2 Y, r# ^" }1 i- A+ p
生成的代码片段如下:0 U7 i( I+ Q& ]- x
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; 五、打包* V! b# Z. q; @! e$ h. |$ V
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。, L, B3 Q$ W4 `+ W: r. u
六、发布
. m) p% p1 b# J' g3 b 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!- Z2 H4 |# e! E, Q
6 g& w; t P2 C* L: j+ s2 }
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~+ j3 x8 e- ^# S
; x4 o1 e% w* ]3 k七、结语
? x( `0 ]9 `" h vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |