一、前言. Z' O) p* W/ ?# F: q3 `
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。& y8 x- v% T% d3 Y2 S% x+ K
二、环境准备! k9 C) p2 `' e( j
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
6 K1 I& H; {# S! o 三、开发者账号申请) u0 V% ~; `+ a- Y C1 o4 a4 C, C
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。. a" K8 W( f* R0 s. p
1.注册并登录 Azure DevOps。: j! B4 x7 T( @8 T V' P
2.选择或者创建一个组织(new organization)。
# x ^- D) n, ` Y3.在该组织下创建一个项目(new project)。
& l1 D0 F G, f8 r- ~) K 以上三步都是为了获取开发者(publisher)的token,获取token如下图:, C" I5 ~- u1 j# C0 T9 \. _
. n/ u) S0 d2 a$ ]1 B4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。! x; \/ F* x, [. k G' ^( X
_% o" F) f# Q3 s- `2 }( F5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
; X- N& O* S3 k7 c, u* n三、项目搭建
( s- S5 \/ u- ?5 W5 O, f1 s1、项目初始化
7 y( v$ T* j6 C9 J+ S6 x6 n5 k- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
) G g8 Z# w5 U: p) ^
( o: ?# H) `" }' g1 w+ r( j2、项目改造
5 k+ Z) }& r, v 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:: C$ n! Y" ?- O t& a
1.将package.json改造成以下模样:* G2 O9 r8 S; X2 Y$ M5 n) D9 N/ R
{
"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包会失败。+ N! m& K: y* [: A' u
3、编码
( }0 c9 w" @/ `6 p5 \ 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
0 q2 l1 @( _) h8 w) G' h{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
$ [# a- d, B) d0 b四、调试
: r' q8 l! z- u. P: w% _! w, f) { 单纯的开发代码片段的话测试和调试都非常简单:
3 \$ n* t3 K8 }) f0 u' ^- 首先先自定义全局的code snippet。
& S0 B# Y( F* ?4 \8 f
0 E- E; ]7 @4 k4 z9 I# P
- 选择新建全局代码片段文件。
& `1 P% p2 D7 A' M v7 Q6 T4 t% I, X
: {. Z! a( c% W: s
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。. Z2 h4 x) `- m9 J% \, X- i5 o, m
( ~! ]' j. V% R+ C0 e- Z* M1 Z- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
7 L, N1 W# Z) p6 U1 Z( F0 d/ v! |
6 _9 c3 f) S; U# [# e 生成的代码片段如下:
9 `% G; W# l' x( a- Uimport 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; 五、打包
% @9 V, i; `: ?2 c 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
9 H" e/ Y1 G9 _ h- w. Y0 c( p六、发布) h( q4 D- |) j" p) O+ [% ] ?9 V, \
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
4 y) ^9 S; D5 k0 X
! D, m7 j) O& B1 _0 |. u* z# e 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~7 ^' F) ~4 z; h& S, ^# x
( H+ D. V: u2 H; s; M; P
七、结语 b" `, _( g, \$ M; n
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |