一、前言* e+ Q+ _# `, [2 w, M. A
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。) q& a1 B0 f: x. e1 R9 z3 X+ O
二、环境准备
" k1 T$ J3 O- a5 O7 p8 @. j- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
; P* ~8 @9 Y) e! S 三、开发者账号申请
# W; S/ F" {+ [% z" { 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。5 B/ y+ c7 V: F. H8 B) X
1.注册并登录 Azure DevOps。0 h0 W$ x$ [2 X9 H$ n
2.选择或者创建一个组织(new organization)。
" Q2 j* ]3 ]( \3 T. h3.在该组织下创建一个项目(new project)。& y! w0 v* g5 w+ X
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
% v0 r/ j; H4 X" d5 h( d' F& q
9 E# S- y) U" U4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。8 i0 f4 ~8 O( u) t2 b2 b
! r0 ?8 p) _, c! }/ h3 S9 X5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
# E8 r7 l( C; s4 f2 C$ z三、项目搭建5 m' n8 b: P9 U
1、项目初始化
x: S. j! V, r3 H- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。1 }; W) w! z2 e* u, A0 J x
! _ Y; f. w j! a2、项目改造
: c8 O% g) ?' c, k" [: I0 y 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:0 G9 w1 ?% X6 T# _9 o: w8 \. |
1.将package.json改造成以下模样:
3 ]+ }$ b Z, e$ E b" D{
"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包会失败。# L5 }+ B/ `' A1 K/ I
3、编码4 i& R$ x) h9 R# j3 Z; q! ]
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
% _4 i: O1 Q; {1 P+ l) p T{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
8 U# m# O9 B. {四、调试
3 U6 F8 P, {/ d, i 单纯的开发代码片段的话测试和调试都非常简单:
. r' ]) O, h2 j" ?# I+ K- 首先先自定义全局的code snippet。
, c/ ~! U9 g Q5 k
6 ~# r0 h* I5 R! `" @6 e
- 选择新建全局代码片段文件。
/ m4 p& ~- s" F8 D
: a7 ^! `4 e5 C7 `- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
! O8 W& c# C1 R8 V, ?* P
2 n* f2 K5 c7 l
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。# H2 b' J# C+ G) w3 B( \; e
0 a2 a# _% B& g3 w
生成的代码片段如下:" l# }6 O- W+ _+ I: g- Y8 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; 五、打包: }" E4 L: w! p7 I5 N y
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。/ ~' V" _* E3 g
六、发布
+ v/ n" l8 N; w: p7 l( D; N 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!$ O; P, y8 c6 p+ h
/ ]- o! v6 N( P- r/ ]. A3 e& P: e& E
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
1 q0 K8 G- G* E w* k
5 f( I$ J5 l& o$ u# m' c
七、结语
2 ?- w3 E `3 ^) o2 v% t8 B" u9 h/ g vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |