一、前言
! H9 U- o, b$ F+ a0 d 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。! M+ _1 A" J: u
二、环境准备 8 R5 \$ i9 q( a- v( Q, Y. Z
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g, r: `) }, A% `
三、开发者账号申请 ' L' T- K5 L; _! }2 l
点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
) N. n2 U, m4 }) e* t 1.注册并登录 Azure DevOps 。
# \. [9 D7 G# P# l% q 2.选择或者创建一个组织(new organization)。# y: d' g5 x6 `& u' ?
3.在该组织下创建一个项目(new project)。
% `4 t; e+ h# e2 S" O) I' v1 A( Y 以上三步都是为了获取开发者(publisher)的token,获取token如下图:: q' E* Y: W! B1 B( @
4 _( `% y, q+ ]' I 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
4 j/ B3 Z+ ]3 N, G
( w$ \4 o5 ?' c. g/ ~ Q
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。! W2 i. z# ^* O' y2 y
三、项目搭建 / C& D5 e% f9 L: h+ ^
1、项目初始化 " m- {1 S* G8 g3 Y# N; w
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
; Q$ @) L& v& C! j% C
! x7 \3 Q8 A$ m. k' E2 {
2、项目改造 6 P6 K! {3 h$ o- c
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
& l9 ]3 Y1 P9 [ 1.将package.json改造成以下模样:) j8 w8 `# n- ~4 U
{
"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包会失败。- Y0 C: E4 h0 w* }! J/ ?( Y
3、编码 * g- H# i6 C5 o$ n# P z
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
6 h+ E/ H3 r G+ N {
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
2 ]# p( a. a& H( T' | 四、调试 0 I0 T( q+ m0 P& {9 m- ~$ b' T$ B" \
单纯的开发代码片段的话测试和调试都非常简单:% Z* Z) C4 ^4 r. _
首先先自定义全局的code snippet。
5 _' }7 p& k* m _
; H- C% ~! E: ~: F8 m
选择新建全局代码片段文件。& w5 N6 J5 Y% S+ d- X9 w7 T7 S" |
2 g+ z: M! f5 ?( E' F* y; J8 e 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。% a$ H; t& C( U9 L+ Q: i
' t, P5 D0 ?3 z, T, u
command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。1 N$ H5 \5 R0 s8 o8 V$ @
9 g8 m6 m9 p w {7 j: W 生成的代码片段如下:& D# \7 r) ^' w, [. A, I& _
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;五、打包
1 d7 g0 {5 Y- m 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
' D4 ^' E/ x [: s 六、发布 2 J& ?: @/ I. h: a) ]1 M" [; f( g( _
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!* P+ \2 P5 h* h* V# @2 T0 ^
# T( a& b- Y* Q/ J. y! f, O6 ]
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~6 j- |+ I. k, Z1 k
2 h" }6 r2 H6 f3 d9 }1 \8 ?8 P, H/ R 七、结语 9 U' O9 K6 D% ^ ?% V7 `; \6 J8 }+ j
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。