一、前言
4 p% [0 C/ n% N( ^- h- m 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。" I4 i! _/ p b/ z# k
二、环境准备
8 ~6 I' b' r& s( ]- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g% Q, A* f/ R2 }, ]" m0 ^' B
三、开发者账号申请 A1 d: k3 e; l, u
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
' q$ s8 b# ^4 j, [1.注册并登录 Azure DevOps。$ A7 n) n* J2 d) H9 V @6 i
2.选择或者创建一个组织(new organization)。
' [9 v& P T' L1 ]8 F3.在该组织下创建一个项目(new project)。3 E' r3 D( l9 M
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
8 V3 h0 V4 l( u/ R" a& J% M- ^4 n
7 |9 x2 ]% M8 g5 J6 `& K2 N* s
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
! O9 {9 y# M9 L9 U; B0 u
( M! W, ?$ t' M5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
2 F: G2 c( U/ L# Z" M5 q$ e三、项目搭建, k1 p" Q4 H2 g8 K( o
1、项目初始化
% Z3 G! X8 ^& F; `3 ]" e; i- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。" e8 A/ k, R; l; `
! A$ ^( o0 w8 ~7 T( Q
2、项目改造" F/ M2 t8 T, q- Y2 O
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
. [+ y# ?+ s9 @5 [ I1 E1.将package.json改造成以下模样:
' C9 x/ H) H6 o{
"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包会失败。% }; ?! a! z5 h5 j5 h$ d- z
3、编码* D7 c l4 z7 z) @& h6 H
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
& P1 ]$ d# K# Q: {{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。' W4 m/ J# s$ d$ k
四、调试
( _- S% c. Q s; z$ j9 |' I, n 单纯的开发代码片段的话测试和调试都非常简单:% ?+ b9 [. x- J9 c" ~, i6 |; {
- 首先先自定义全局的code snippet。 U) ~8 r( W) A4 U2 d
' V1 C6 q: h7 m' i& N! W+ B7 J- 选择新建全局代码片段文件。9 i* E. v2 N, m7 t; ^7 t8 |* U
- e$ l: e) v3 `" K# Q! [
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
" {: i! C3 y1 B. V- C5 P# v$ ^
N' F$ e% q O
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。, x, Q5 `/ i- ]! T0 a
- E W1 G& D, K/ m7 m" M& N
生成的代码片段如下:
; `1 i P/ t$ e: a' z# I2 e6 yimport 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; 五、打包/ N+ |0 A* a+ x
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: M, J' l7 c3 H; T
六、发布
4 P, k; f/ x m- z. G k: l 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!( F, C+ `4 I6 R
; T; ?8 g- v4 a7 I9 ` 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
: o4 x9 J8 X. M2 k! ]+ F
% J$ S( y# ^% _% _) s8 z
七、结语
; W3 \; c' I7 ] vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |