一、前言( Q, z5 E- ^+ K/ W: V- ?) `
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。+ a# f" x! C1 d5 J
二、环境准备
& a$ a( O/ c$ S' z; ^' M" r- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g0 g1 o5 u5 Y" {# R7 R' X! [
三、开发者账号申请
. E$ p d" z b$ V0 N9 T9 a5 y 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。7 J7 B9 h& D( D6 o0 X
1.注册并登录 Azure DevOps。/ c# B4 I5 I! L1 \
2.选择或者创建一个组织(new organization)。
6 F% }, K8 p! P* c3.在该组织下创建一个项目(new project)。
6 E' |: N+ |; K0 p" W5 ? 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
4 i; h8 S' W3 l5 S7 k" _
# y' T7 q, U" a. n8 [4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。4 ]4 I* Z6 x7 n
1 [( M$ h+ G) K9 m- [, o4 | ?' P
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
3 N8 ^; }% r) X' B三、项目搭建2 I2 W" J, z3 L1 I' s2 N/ ^4 g
1、项目初始化) Y; s6 o- ?% j0 L9 f3 a, V) P. J
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。3 \9 i/ o, ^+ F: Y& W! [3 D+ C( @
4 {& {. k8 z+ ^2、项目改造
$ y5 n! ?$ t3 ^6 z+ F! A4 u4 e. F) G 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
) W9 @8 J i! A9 f1.将package.json改造成以下模样:7 C6 ]/ [7 P5 O7 C9 r/ S' X
{
"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包会失败。
6 m) W* o1 \* l0 G5 Q9 `$ \3、编码
0 o* Q( b; f) p4 u9 k! \+ ? 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:% A, `; l$ A5 {4 h
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
1 e" F* _. U% M2 \+ P1 ? l! @四、调试3 I' r H7 i" \
单纯的开发代码片段的话测试和调试都非常简单:/ ^, Y" k1 s: Y$ k- `
- 首先先自定义全局的code snippet。5 c4 i: ] D" h
4 _% T( o4 J( ?# z" l; `- 选择新建全局代码片段文件。- q" Z/ j8 k( |2 j0 g" H) J" y% M4 g
' b& w: D4 K& Y
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。4 Z2 Z' @5 o* ?+ j8 t, t/ B$ W
3 G1 n, V. I" y2 K7 x
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
; t8 `3 v0 Q, n2 J8 l) p- w, F, U
6 f3 {. E6 p7 V, u$ Z 生成的代码片段如下:
, N8 X: |+ |% b7 ], w6 h& h& t; kimport 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; 五、打包
$ r0 Z& B. z* A0 M- U 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: @+ X# J7 r0 g; Q' L1 C$ N
六、发布
) `4 ^; F) t/ [* b/ o 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
7 |3 P# g. n- c3 l
1 E# x' Y$ ?8 w! _0 H* N+ `9 N! p 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~; Q' I# ?5 t! F2 g) g; y
( S. @3 Q8 B5 w$ S# ^: n+ h. T七、结语
) s/ ]+ T$ R/ T; B$ C vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |