一、前言( V% x6 Z2 t" W& R! T9 g
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
4 G( w# U$ X4 W4 L/ y二、环境准备
6 m4 R1 s3 b4 ? k7 F4 L- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
$ ]" Y/ w5 \( d1 _6 O' u 三、开发者账号申请
! r3 t: O& P$ i$ T; U3 T$ J( I: J1 s: l 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
% R( }- a+ o! o3 C3 g1.注册并登录 Azure DevOps。
: B: q3 x! F; e$ [2 k# Y. Z2.选择或者创建一个组织(new organization)。5 v1 T) o% n2 ~. P1 h( Q, k
3.在该组织下创建一个项目(new project)。
2 e, H& {" G! g/ d% l9 b 以上三步都是为了获取开发者(publisher)的token,获取token如下图:, v& y+ ?. N9 ^4 \# F; g2 d% z2 \9 f
9 w q3 \6 T) P+ {; |4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。. f ~6 g; Y# a; I8 h0 b8 B
9 Y- P q" k& m. B' ^8 M5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。% r; s( |! F0 f, T" b
三、项目搭建7 R) _8 `* P9 p- F
1、项目初始化5 D+ N. n( b& }+ q# k6 [
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
6 R( n2 a/ C' @; ]# k: t# V' B1 t
6 M _2 S ~: F- e% N( b% j* U2、项目改造
/ z5 r9 I9 y6 G& \3 p 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:# v6 Q' X: O9 v' [
1.将package.json改造成以下模样:0 m9 d# q. W5 n6 K) v
{
"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包会失败。
8 `! U; @* S2 g* P. D3、编码
( F5 g h: F) S# H 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
/ T; q0 m7 \- b2 Y! 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
& b ^; c+ W' ~' i# K- l$ L4 `四、调试
6 Q1 ?5 |; ^7 B 单纯的开发代码片段的话测试和调试都非常简单:
, X/ t* e$ p+ C" |- 首先先自定义全局的code snippet。
4 p! J2 x3 F+ }/ \ a
0 ?' H$ e( f- ]( l& B8 ]- 选择新建全局代码片段文件。
; _8 H! o" f P9 l& {
$ g6 r" F0 Z9 z, ?" I2 A- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
5 N! c( y, k+ [
5 E, z' `, z7 ^5 b. @$ T% {- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。1 ~# g' X6 y' i u: v+ x- D' L
$ E6 t( B/ ]5 e. j 生成的代码片段如下:
( j3 l1 W7 i8 F1 D$ U1 B8 Jimport 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; 五、打包
1 j& ^1 s, O& s6 A. O1 L4 N 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
3 W% v$ O% V% ]0 r六、发布
+ r1 E0 `+ ^- n/ Z7 q7 ~4 J8 j 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
: \. Q9 Q& j' a/ s' n* _! z) f
& ?3 G9 ~ S* i& S& p
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~/ v9 h [8 z7 [! B7 l" C
' ~7 l/ {5 I; m: j七、结语: i" Q1 C9 B0 q$ z: [
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |