一、前言
3 C/ M m& X6 \" S9 \ 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。0 [5 z5 J7 K& n7 v& [- o
二、环境准备* b, O( E0 Z; L( o$ Y/ `, F& U2 g
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
) S$ l3 M/ o8 ^! Y A" }! m/ t 三、开发者账号申请
+ e- }5 k+ f0 d4 p2 C 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。( o- [1 ~& h$ P9 Z$ b# ^, e
1.注册并登录 Azure DevOps。+ a4 C+ M' h7 G
2.选择或者创建一个组织(new organization)。: F: u) V( v9 \3 E; u+ d0 _
3.在该组织下创建一个项目(new project)。
' ^' ^% H- E0 v2 v% ?9 u 以上三步都是为了获取开发者(publisher)的token,获取token如下图:1 m. X, ~9 c$ S: T/ ]7 M" r
" Y- K# _& b5 C4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。% K* y i) q; k
! W+ }8 y' e, z6 B( v% L5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
. f' o g8 [& ?三、项目搭建
" C- B/ J6 u: p# { n1、项目初始化
0 u! @8 j7 S. R2 T% n, G2 ]: ^- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。; D/ `; g2 ^! ?, W; `
( @" v2 }* p! g$ ]: n2、项目改造
/ n' z+ F- M# P N6 f4 g 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
1 e9 B. i) c" f+ }; f5 c9 x7 V1.将package.json改造成以下模样:
7 Q# K% U, p: R{
"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 F5 D( { w+ ?3 D: b
3、编码0 S% s5 v! L$ _" @
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:# ^/ F+ z) p* J5 x0 v
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。& @. l8 D* y: B; }# j$ Y
四、调试9 c4 l1 N- d3 j% e0 M% y/ f2 Z: A
单纯的开发代码片段的话测试和调试都非常简单:
* _# v" Z! G6 q2 V6 p8 n d- 首先先自定义全局的code snippet。
: q2 _2 q) d# `' ~
% Z. k; S) ~- S# N2 t; ^6 Y& ~' Z, Q
- 选择新建全局代码片段文件。
! r* K( C* F; Q( ^) y( [' T- |; X
% s, P( b; A# G: m5 A1 L3 }2 E
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。5 Z0 b2 K! Z- @9 U/ E
" ~0 \; g& f7 A6 @
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。8 R( I7 G! u" ~3 x
9 k: s/ Q. u7 l
生成的代码片段如下:
0 q) u3 X8 Y) ] L5 Oimport 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; 五、打包
9 C6 T9 Q! q, b3 E; c. {1 B; Q. s 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。4 i" t4 s: q) N! x7 S) u8 S
六、发布* z T8 r. g9 e
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
3 E/ m: o3 r1 p% o* A! J
* ^5 P7 m8 t( `+ V! _# l 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~9 Q. e" V8 p& `/ ~' u( b0 U g
" m- N3 y5 {" E4 S$ c
七、结语
3 G0 b9 g5 J6 b1 x vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |