一、前言! X0 i5 b' U% t3 s3 }
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。" o" B s% b! S2 Z
二、环境准备% H: n! x7 H# K6 t( }; a: Z0 O
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
8 M8 Q/ w- v5 r' R: t7 s: m 三、开发者账号申请
" s: ^- e) p( b8 x# D 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。# T# V {# ~/ h3 |: J# `, \
1.注册并登录 Azure DevOps。
3 f% T7 ^" e" F# N' B! b2.选择或者创建一个组织(new organization)。6 m e+ L7 g: |6 n1 O6 D% t
3.在该组织下创建一个项目(new project)。+ W. T% d- o+ L8 A" {9 J" ?+ \8 J' V
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
" O/ E( h* K1 r6 Q4 i) G
# [& e! r# J: i: ?. \8 f) E! H
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。$ k" B' d% C% O
4 t& y/ g$ B, X9 ]
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
$ H, F9 w( R" H- W+ |, r5 x三、项目搭建
9 c, X+ [) v4 i3 W a+ u6 m& ~7 ~1、项目初始化 o$ P, N n. M' J1 W# k
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。# z$ T# Y1 k9 A' `
4 I6 i1 U# R/ O; R9 }' Z# Y& {7 E2、项目改造4 r9 U5 b( _, l4 Y4 V) n8 G
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
, r+ n- Q3 i u6 C% Y. Q$ Q1.将package.json改造成以下模样:4 C$ P8 a/ M0 }/ I% K
{
"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包会失败。
) M! {" s2 n- Q' @) x- Z3、编码
3 F4 O7 m7 x3 [# w8 g 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:) ]) N3 J$ t6 z# [
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。7 Q+ Q! g" D/ m# Y( p2 t; l j2 n$ O
四、调试+ O( m' U+ m, w% y
单纯的开发代码片段的话测试和调试都非常简单:/ z% w" E- s# O
- 首先先自定义全局的code snippet。
: E, {' p* w6 j
8 e* T) `& d; M8 \. Q' O5 ?- 选择新建全局代码片段文件。/ w9 \' F7 E- z! w
+ Y* P( @& T, c9 ^: I
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
: R! U' p% I1 z; ?* p# P# V
2 n9 ?# w! l z. o: d# L
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
4 F" f* @4 g4 N1 k* r6 Q
) G: N; n/ Q3 B. j, J& O
生成的代码片段如下:6 }6 y' K7 Y7 `5 e* R( e# J
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; 五、打包2 i/ z6 ?1 j4 Y8 j
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。, ^, u! a3 S* l; h: M* V0 W% B
六、发布0 `" E3 [& m' E6 O: }
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!8 G) Y" U% n1 D& h
* d8 W) x# b" w8 V' Z" g
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~$ p; [) n* \1 p% w# ]
9 {: |& e( X0 T2 c% S5 A
七、结语
: g+ @9 v5 r9 N vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |