一、前言! T6 `- z1 d( A: f
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
; T* V. K; m- q1 D$ B/ @1 \ v二、环境准备
$ u0 _5 l8 w4 g7 Z- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g* A% C7 c3 N* m# C$ c5 H; E
三、开发者账号申请3 C3 U) {/ [! e. s: I9 S
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
+ W5 x& X" k4 E x. A1 }1.注册并登录 Azure DevOps。( R* J; z: ^$ T- F1 J h
2.选择或者创建一个组织(new organization)。! @7 L6 W+ t0 z3 q7 `6 e
3.在该组织下创建一个项目(new project)。
8 _$ S! x Y2 e. V( F/ z+ ]3 N+ d 以上三步都是为了获取开发者(publisher)的token,获取token如下图:# b6 e) o) M+ ^ G! J! z
( Q/ N6 {! a. B+ `4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。! [& V9 V6 i" F- z' S; r, a \( D( U
* j; ?% g) [* D3 k5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。5 z* |2 i! O" a3 S% a- T2 ~* Q4 ^) x
三、项目搭建
- I: c; [3 l* c" b1、项目初始化
9 H( u. H# @% w4 R2 H, {& N- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。 M0 ]; B4 Y# F9 E7 R& L5 }
& w; q. Z, e( \; }$ f+ i0 F
2、项目改造+ l; Y9 ?4 t1 n! r O
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:1 K4 l, H ~3 g0 D* X
1.将package.json改造成以下模样:
) P3 w7 \6 s6 Q" b! 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包会失败。
# G2 K8 D: s0 R3 O$ H- K3、编码8 B1 \8 g3 ~) p
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
0 I) O+ h2 o% t6 F0 m{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。, ]- s( p/ h/ D$ e8 n6 D
四、调试
* }5 W& N K/ } 单纯的开发代码片段的话测试和调试都非常简单: S7 y' n( d& t" k
- 首先先自定义全局的code snippet。
# p7 ^9 y- h4 V) r6 z- D; o7 l
# K$ x3 ~6 h7 T y. e/ z' W- 选择新建全局代码片段文件。
( v: w5 M2 _6 p
9 a4 h& t7 T. X' {
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。. V8 X" ?# ]3 c$ j+ y8 U R: ?: P
; k5 V, w# c! }; r# R- J9 _+ Z- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
. m7 p& b$ j6 x# z a: ], N
% x7 r$ W! n$ _# X% C' b: C
生成的代码片段如下:
5 `1 ^5 P2 _7 t& k; Rimport 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; 五、打包/ P/ `: Y9 T* a1 W2 u& b
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: [2 I. U. J l4 ^3 n0 c
六、发布: l2 j* \! x, p& Z2 ^
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
* \$ E/ Z T1 `8 `7 C- c( l
+ [4 X4 t+ r* R# F0 t* `: f
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
# ?' v% b; H2 g3 ?
5 T4 ^7 l* M8 L$ y$ k d七、结语6 e y& K: O. x- y. h7 @
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |