一、前言
8 I2 j! m' k# j 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。! c3 _+ F X5 W4 j7 _' ^- K6 z' J( y
二、环境准备 t T4 M/ y& ?! w d5 q6 q7 e
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
* E4 }. r+ b" `" {1 ]. c: i5 Q 三、开发者账号申请
9 `0 ?6 h2 v. n; p! R; g; d 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
7 ~8 p& P3 X2 H/ w; n8 a1.注册并登录 Azure DevOps。$ f& `+ `3 N5 V; r/ E7 D
2.选择或者创建一个组织(new organization)。8 n7 W, K y1 U6 S$ c/ N! `2 z
3.在该组织下创建一个项目(new project)。) g; ]+ a; T# \% q% [
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
& x1 U E* _5 Z4 [& S# }; {& I
: c4 e1 h$ C& x" J4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。- ?- V* O+ J: v v1 _# ~7 R- m0 I
& T$ I+ o% R. ^2 z, [* H
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
8 R) N: D. c( X$ q z三、项目搭建# `) ]& T5 q1 [8 G1 H
1、项目初始化
) b) p2 M% V% }5 T/ U- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
* ]9 f0 `! s' ^, E
9 I7 W3 ]3 }8 H* I& Z: o2、项目改造. }& ?0 J5 z4 J& l6 _
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
. b% s( _& m" N- a% M5 _1.将package.json改造成以下模样:
0 v7 C3 {% R& l3 |{
"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包会失败。
& B t* ^- k; m/ s7 U# \8 M3、编码# X* M" h# q7 t( B* C( u+ S
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
) u. j( j% f/ L( W{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。+ v" C P* |* O4 I9 a& A
四、调试: x+ ~$ I8 N; o" q0 l4 o
单纯的开发代码片段的话测试和调试都非常简单:
8 C% p+ k! v1 C; d8 Q8 f# E- 首先先自定义全局的code snippet。
2 n l; B* g! Y) A, Y6 I
$ F" t. U$ f2 _
- 选择新建全局代码片段文件。( U% W4 p0 X/ D/ d
; C+ B% H% N* Q' b8 Q1 }
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。, `2 K# {8 C# v/ a
7 C+ d3 g, G" a2 C3 K% X
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。1 A2 V* M* w3 z& O; X
! ]( a8 x+ @( w, P/ w* l; E 生成的代码片段如下:' Q1 X* ~& l6 L2 n
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; 五、打包
- V- ?$ x. g" L; [ 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。( ]( F8 l, ~2 P, N8 n
六、发布$ v' G$ U! I2 G0 L! s1 A
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!4 x' Y+ C) e; f8 p
3 |( F- t, I, @ 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
- a: D- y/ [" H7 Y' s- Z0 P5 U
; a% U3 U7 K: H) M6 I
七、结语
$ M" |' @6 E4 _ vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |