一、前言$ y7 H3 I- f3 ]7 A; ~ a5 s
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。4 q1 w3 P- V! L
二、环境准备! q6 {2 a3 U4 S8 D& \& v8 q
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
: {- L. F7 M' x% \- R 三、开发者账号申请2 r4 b9 y* `% V. T+ }8 N9 Q
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。2 u( g! z% e& b0 F& W7 ~! i
1.注册并登录 Azure DevOps。
! R3 f) U. ?# h5 v. L2.选择或者创建一个组织(new organization)。2 `! x, r. G6 v- s4 u6 |2 V
3.在该组织下创建一个项目(new project)。7 G2 R- D' t6 R% s3 y: o4 B
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
8 R7 G/ Z( T* Z) P
7 ~) e4 e! E- P7 A
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。9 @3 G: Z$ e! K4 x
7 ~5 s4 h; h f" M# k
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
5 X$ q ]+ U% \: K* g三、项目搭建
- i% Y' J# J( m; t1、项目初始化
8 G, A1 g, q3 f% W- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
& Z6 W3 M5 [' W
" G& w1 a# D3 _+ O+ f7 H& ?! E2、项目改造. ~6 u* T6 e! P& ?- {8 a4 y
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
" z: x Z9 e, A; l, s( h! q1.将package.json改造成以下模样:
0 q1 L7 Z {' y7 {- m1 l s' ]- [{
"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包会失败。
) V6 m7 o( e0 d* y( r3、编码% d- J! J: q2 \3 V, M$ f ^5 S
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:& ?/ d2 K" T4 R; t* s6 a
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
) F& m2 K% y. z5 U3 y四、调试
8 r4 P( q* | {8 T& X 单纯的开发代码片段的话测试和调试都非常简单:+ Z8 D- x$ D% H: v$ [$ E6 p
- 首先先自定义全局的code snippet。' ~8 P9 S; h' [! H8 O" e4 D
3 \6 _* v0 p7 N1 T3 q0 z7 h, Y- 选择新建全局代码片段文件。
* ?# s2 r6 E: Z. \7 t8 [
% D9 r- `* C9 w( g2 Z% _2 J# B$ Z
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。$ x% ^- c' X1 u/ A
' r( V$ h3 D0 O2 _. T2 P' F- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。" F$ H) |1 R4 y* J
9 f1 V) i r/ r+ `4 | 生成的代码片段如下:$ \; r. k: U- X' T w
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; 五、打包
' F4 j5 H, }3 r) q7 l9 [4 \( ]0 r 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。+ Q7 s1 o/ p9 Q) s# f
六、发布
4 d! v7 I* r3 l: M 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
0 a0 e5 b3 X+ _+ ?; h" R
9 Q, I1 o! \8 {# G- p* h; `
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~ a$ j9 }/ z" o; }! ?
( T# T9 ~' n" j1 F1 G: e- b1 l9 Q
七、结语
G9 H( F- B9 v vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |