一、前言8 ^* |) b9 b' p! [* Z, t: q1 [
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
9 W' q7 {+ p: r% E6 j1 g二、环境准备5 B$ D6 z+ s o. m& [% O; S
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g8 K+ S; E- o# a+ }$ e3 @& {2 A- V! W9 [
三、开发者账号申请. g2 }' J; Y: e2 s
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
2 \4 M o4 J3 F! I2 F1.注册并登录 Azure DevOps。
9 }/ J0 T2 |7 ?: ^) K9 q# z( G5 k1 c2.选择或者创建一个组织(new organization)。
+ d8 b B8 u; i" g# j4 g3.在该组织下创建一个项目(new project)。9 ^5 g) v, Z# s/ |) v7 D7 M3 q n! A
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
' [( v+ ?; y$ R" G* u
' W' ]9 \7 g1 X( d: h9 j4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。 t% ~7 i% M2 L5 |# W, |* s
+ \$ ~2 N; m7 z6 M% ?; y6 S( {5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。( p% F h& z) `! c4 w2 \' C4 Q
三、项目搭建$ H7 P9 t/ r" _# ?. C% [
1、项目初始化
, q: |# z6 } U E: s0 W- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
2 r3 | d% r, x8 b# P# r! i" Q
; e0 U. N; L/ I( U1 F- K% ]
2、项目改造$ O4 h4 O" l+ B: r
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
( A7 W* H2 [/ G9 j1.将package.json改造成以下模样:; \: F# r/ |1 y
{
"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包会失败。
, W, Q2 Q; ~, N3 @3、编码1 m3 q0 K$ I7 b" H$ ~
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
+ D5 U6 @1 c" f) I6 y2 \# Z{
"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- ?- q b! j6 B( @
四、调试/ j: W: F" U7 F, g9 M
单纯的开发代码片段的话测试和调试都非常简单:0 W. Y3 h1 j, g( q
- 首先先自定义全局的code snippet。
" r& e* g7 {0 J% I6 K l
b/ F' m9 `: M9 P( v! [2 a5 p4 ^% A
- 选择新建全局代码片段文件。0 U# X, S+ g: s3 S* {
4 h) z) _* e" V: b. D, r( g
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。6 T( {( L s) n
# k2 i: C% E" P/ f$ V- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
. o% J+ p2 n8 V3 B4 } l! W0 w( ~
0 n$ K. i6 S5 q6 p4 F 生成的代码片段如下:
5 K/ w; D$ l6 N5 pimport 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; 五、打包
7 I; [# {" L& A2 w% j5 c* [3 P$ i. p. u/ ~ 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。# W( ]; c: h9 Z; P* o- m5 w9 ?
六、发布
3 c7 ^! \+ l2 n 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!& [9 p% Y. e) h- {& k8 ?/ n
( @0 ]# C0 a: T9 R0 M
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
; k/ @1 Z6 U" N0 m A
% T' ?% V3 |- C. n* T2 W Z
七、结语
4 g2 K1 R: @/ B: h8 t0 g. |7 Z$ d. e8 M vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |