一、前言 2 C3 [4 n8 T3 n6 I/ Q
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
% t- `4 v* x K4 ~8 ?* d 二、环境准备
' \9 a( }' J/ H0 i; X* f node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
/ |. \; m# q4 ~0 U N N1 q/ T 三、开发者账号申请
r7 }; f/ a. `9 I" I# q9 P 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。: R" |) Q, l: o7 Z/ X3 f+ V
1.注册并登录 Azure DevOps 。/ ~$ |2 s6 u* H
2.选择或者创建一个组织(new organization)。
$ m x# }/ d- d/ M. k ~ 3.在该组织下创建一个项目(new project)。
7 a- v! q' V ^, {. ]0 O4 x 以上三步都是为了获取开发者(publisher)的token,获取token如下图:7 @. Y6 a: P k& D
/ M. B+ C j; w B7 n
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
/ i( o8 ~6 R2 c
: y7 g7 r! q* ]- ^2 r( G. x G
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
* C# G, i$ W" W3 G6 l9 y 三、项目搭建
5 |: P5 u v" R9 {' k0 y: s 1、项目初始化
" S- C' `. X1 s5 n3 u. r9 W 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
0 O% B* E7 s1 U' ^
. R+ Q( ?1 z) ^
2、项目改造
K( |3 U! @3 d% j1 F3 ] 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:; t( _' T9 s, m: C
1.将package.json改造成以下模样:
* P2 \ N' K* [1 q5 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包会失败。6 i0 U( D+ N* i+ y3 D! m! ^
3、编码
4 V& E: [# I+ D 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
+ j0 ~2 j1 d; v# b" x6 X& G: I; g {
"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 P, H2 q8 ~/ C* M: u6 s- K% k 四、调试
9 S. \, S: ~: h/ m6 s 单纯的开发代码片段的话测试和调试都非常简单:
- t# \/ `9 A2 |4 r2 } 首先先自定义全局的code snippet。, W9 ?. X% k2 z ?& n# h
1 c, ]3 D/ B) d5 b( F) R, w9 o0 h 选择新建全局代码片段文件。
8 |# E; T, u; G1 l
% e+ z; G: b; X 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
2 P' m$ _+ B# `0 [3 ^- B! _
. C. r& P% s5 x B command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。+ x( t9 [5 S$ y& P
" r3 I& i7 K/ E% w# W* {
生成的代码片段如下:* D3 r: l! {& f/ C0 d! W( w
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;五、打包 7 v% t% o" o7 S& X! o) L3 M5 c
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
9 X/ w( P9 n# `3 b/ L 六、发布
& M: S) \3 N( \ 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!0 C# N- a% a2 U6 F' E" R
& z' B4 q' {& L) V3 D, v 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~- [8 g" d; h% a" ?
& Q1 n4 p L, U2 |: w4 E 七、结语
, W, v4 V. k2 Y- R# A1 x vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。