一、前言
8 Q" v! M9 x7 F6 q* a 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。 u$ f& O& Z/ }* \
二、环境准备
d+ m- E- ~0 C$ \ h- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
1 x: C+ i8 C6 p7 Z 三、开发者账号申请3 R2 Y# m* {* d |4 j. T( s6 @3 W
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。; w% B- i& O- t8 X
1.注册并登录 Azure DevOps。
4 [2 u P) `7 m4 E% [2.选择或者创建一个组织(new organization)。) D" c q3 V$ V5 _* K' G
3.在该组织下创建一个项目(new project)。
8 C$ t1 i2 M7 ?% w& h 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
/ e8 M- ?! F# T: ?$ p: \, s
: E- I) E3 P2 \. l
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
3 ^' W6 L( `$ `/ Z. k( R7 j3 Q j
1 I7 l l3 p: S' q) O
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
) j. Y) ^( ~3 K* B' g* g三、项目搭建% o% W! j5 h9 a7 X; j/ ~
1、项目初始化8 z$ _+ t3 E0 @' h7 T+ o8 i! s4 a
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。; j5 X. J! _* h1 c! `! q
( Z( N1 l8 B2 L M, p2、项目改造- p7 i8 e6 {$ Z. H+ \
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
5 x# g j1 u) M6 i, ^9 `1 k% F1.将package.json改造成以下模样:
) ~2 Q4 y; K2 N1 l{
"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包会失败。$ P) @2 T& G1 [; |! p: l* E$ ]
3、编码6 v1 O$ s; _8 j: `% _
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
3 z* z. r3 H" z6 h) Y- ]% c{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
9 w. h( X7 ~6 p; M& n7 S四、调试
6 G8 h8 E7 t" F- o8 I 单纯的开发代码片段的话测试和调试都非常简单:
$ T; X! o( @2 Z% @+ y4 Y+ H- 首先先自定义全局的code snippet。! z4 }5 }4 }' J% |
8 j) i" ?1 U0 Z9 H) W% O: Q- 选择新建全局代码片段文件。
! o! D* m; {- D! h, {+ v
$ _$ m4 R9 A0 q; K- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。$ i7 a+ u4 Z l+ w+ }
& M1 a% U v: U7 j2 P" I' G! {- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
; `' W: X7 \ H
9 G! O* e" P) f* F 生成的代码片段如下:
3 s3 X, W, i& timport 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; 五、打包
8 q: V, M, @7 h: }% E& i* ~, n# D" A 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。( T6 n5 g$ B# Z3 u
六、发布
3 W( y( s& A' l 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!* Q% z3 k. |# a6 N- E2 e5 G
) v7 P$ }7 x# x6 m/ ?
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~* u$ A1 r9 B7 I% S
- t) ?' j8 c3 L+ {, }5 F) E+ J6 L- m七、结语3 w& Y; _) f% `3 g& K; ~3 m, a
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |