一、前言
5 {$ ^5 |& } I( L% @ 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
, L4 i5 ^$ x1 @ b0 g& H二、环境准备
0 V- \1 P7 H2 m( [& q+ ~- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
) }, D2 n2 v0 _$ L+ ?0 p+ M 三、开发者账号申请6 Y) S9 }# [ d* F/ M; p w
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。3 p% {* F% s( u
1.注册并登录 Azure DevOps。* x' W2 D( t! D; v$ f
2.选择或者创建一个组织(new organization)。# B; [, N- X) Y: }" l9 D8 s' p, ~$ x8 W5 G
3.在该组织下创建一个项目(new project)。
) r2 `3 s/ P4 c. A% P7 ^- w) U 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
8 H6 e/ v2 W' ]( p# B; f4 }
u5 s) o5 Y8 d4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。" \% M0 s" @$ a0 p7 L+ |% I1 {/ o
. A% i7 c. M4 c* g5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
% E. a# T( }) X2 }0 c O三、项目搭建. T) m3 Q& t% M6 s* k3 y' e
1、项目初始化( b7 X- f. {* c9 C3 @) z9 x* r
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。7 ~6 J: { T3 F1 L7 Z
% }3 Y! l* `; k9 }! K0 |+ z: M
2、项目改造( p/ C w; V' \/ D6 G# d6 G4 x
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:! R' o$ T. k9 j" ~ a
1.将package.json改造成以下模样:+ ]# I- H; g! [0 H
{
"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包会失败。
: {: [9 G' _% c/ t0 [3、编码; k9 V& U) Y5 E$ U) V0 l' `
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:. S. r! b, I) T; g( R
{
"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 t+ V* T) _+ t" [! ?3 ?( e
四、调试9 v0 ~" \0 d ]" A6 l7 S& [
单纯的开发代码片段的话测试和调试都非常简单:2 d7 t9 E6 P b
- 首先先自定义全局的code snippet。 U/ a4 p1 K# E
0 I; e" X, [( a0 e3 \- 选择新建全局代码片段文件。
# P! g2 F& b, K0 t
* P. {) y9 i `6 a3 `
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。' l2 O5 g/ P4 B- K# l
5 z2 I w, m' x ]3 N( b( n) I! A: u- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。) @* T3 E a+ w# {# `0 w, y! Z+ V
3 I* J" k4 O4 @8 @2 T; V1 a3 ]3 O
生成的代码片段如下:: N, f3 R9 |; `' Z _/ E. `
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; 五、打包0 ?0 O2 n) b9 M- W
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。& ^ M9 z9 P' U: ?: J7 W* d! ]
六、发布8 z1 H) t3 D- r' o, F( b
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!- s$ u! V3 ^4 i" _, a
' O+ f8 g( K" b# @0 F
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~) J8 d' O& L ]# f" Q
5 U/ h2 X5 N. Z5 `8 i5 c七、结语: O" a6 {3 k' p
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |