一、前言
z0 E3 {( D/ g# H. _9 X n' L2 T2 V 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
& ?3 s# t4 O, G+ j* R3 k4 |0 Z( N5 n 二、环境准备 J7 C# \3 \4 N: Z$ @
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g/ U* ]1 [; u/ L z6 v
三、开发者账号申请
6 b4 `& u& O" g. ` 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
, h9 Z3 I7 _& w! _& U; n' D" t 1.注册并登录 Azure DevOps 。
# l& _0 i3 A. l6 |) e$ E 2.选择或者创建一个组织(new organization)。3 T! H. A; _8 ~) Z% ~4 h# G3 [
3.在该组织下创建一个项目(new project)。. Q9 x2 ?3 L& X
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
7 m- |2 Z, p# w( K2 d0 s4 e$ \
, ~3 `" a; J! x! ]3 M& N2 ? 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。9 Q Z( Y% H9 W& Y7 U& ~
4 o3 ~5 M! t _5 P1 K
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。 C4 S. b0 i4 O9 R/ O3 Z' s
三、项目搭建 " x+ L) p0 W" E, @; @
1、项目初始化 1 m8 u9 J9 O1 y n2 Q
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
4 A) v) \3 [+ r' E7 j9 l
4 j/ H3 \( L8 m1 J0 _3 K# R 2、项目改造 : o, P& T3 n8 s& Z& t
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:/ X) w: C& \5 y& _: Q
1.将package.json改造成以下模样:
9 Q; ?( t$ a7 D {
"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包会失败。
" K1 H) I! E, i* F9 Z3 j 3、编码 & C" {# C, Z4 q0 C) n. V
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:/ ^0 m, M( x3 r+ ^# N5 C( T
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。+ u) E4 I1 A) t' J; y, _$ X
四、调试 + s. b0 P! g& |( S9 A3 @! c' d
单纯的开发代码片段的话测试和调试都非常简单:1 {$ X& H+ T4 S& v
首先先自定义全局的code snippet。
( U5 }* R3 Z5 H5 @
$ A2 t; B. q9 g4 b* A4 f$ N 选择新建全局代码片段文件。6 B f) ^" F1 K; `1 n, F/ ]- g
7 o# v7 p; U; ?# G- m/ u3 O0 H9 G
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。4 G& w x K5 p) E6 A: D' r* O( |, S9 S
! j1 X" F }, t command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。. u' C: ~/ o2 r5 t1 E4 d- ~! T: U
+ ] ]+ h! p5 @. W+ H, s+ m# B
生成的代码片段如下:
) j x( G8 v; a# Y1 m. y 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;五、打包 % q6 v- H: y3 Z6 Q1 c
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
0 L$ F# m0 S* @( O! F 六、发布 0 o) d7 l$ s2 l* _, z5 V; L
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
- h" L7 `4 Q7 t! z! ~$ z8 {) Z' \
9 {6 E1 g8 N1 @' d" W5 @, p5 R6 v
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
# p/ o ?5 F& w: a' V" c8 n
+ \5 Q( b+ G5 I+ q; e+ `2 a& C
七、结语 2 x+ |" I6 C i! O0 s& z. A
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。