一、前言
; f, ^% i4 P+ B% z7 x, V 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。* E; a+ p9 C5 ?0 J8 l, d8 g
二、环境准备4 H# l% l( s7 I! o/ j" f
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
1 d4 i6 ^. Z$ x; u 三、开发者账号申请, }: w, \4 w2 f% n3 v: Y# Q
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
% s1 L4 }7 }# n% i( u1.注册并登录 Azure DevOps。
- j9 s/ C7 Y% t5 q. t2.选择或者创建一个组织(new organization)。
- c4 b1 w% {& }6 L) Y/ H, y3.在该组织下创建一个项目(new project)。- ]/ |. U; z8 _3 X' ]3 \0 d* h
以上三步都是为了获取开发者(publisher)的token,获取token如下图:. X2 k( Y. @* n. a
@8 v* x4 \% O! N8 t4 \; a
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
+ ?2 D) ?, Y3 ?/ b4 M! X- j9 e
, n. o9 y$ y; s* d5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
g5 J- E% [2 u$ W5 o三、项目搭建
+ s( ~+ S6 s' Q1、项目初始化
! k, n1 r' X; ?0 i& C: q# m0 X- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。$ B8 I( a4 e7 s0 t
( W; Y8 m- _3 J9 m# B: `, V2、项目改造6 l- Q+ r7 S, s. K
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
3 i- J6 X/ N& `! Y3 a1.将package.json改造成以下模样:
/ U0 W! Q; F4 l{
"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包会失败。7 Y# `, ], f2 k) `6 m* [, R# Q
3、编码
& c5 N: ?0 \5 K* b9 k! J 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:, r! O, L, ~3 ~8 X- g" U5 M
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。. l7 h( @0 R+ o! W7 q2 F# F7 N- S
四、调试/ ^" v3 \3 i$ h% `
单纯的开发代码片段的话测试和调试都非常简单:
# [' A. |' g& c( p# K0 {- 首先先自定义全局的code snippet。
0 d6 [+ J. L/ Z
3 H+ j+ R% T) ]2 _: m* U) }6 b- 选择新建全局代码片段文件。
( G' L9 ?& V) q9 u) d
6 D- v* w/ d6 Q% \% x: v' h
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
5 X6 y( M R ]: h
, ^4 f9 ?1 |( }- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。6 h# b0 L! ?- I: \9 k' _+ E
( v: K( r9 W) Q* j! A 生成的代码片段如下:) L% K* r+ k: D2 ^ m
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; 五、打包
* i$ I' n* i( o' T 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。 Z. Q" J5 ~/ q! x4 y
六、发布/ y7 a! a O$ \
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
7 `5 [% ]% h2 g, R; g& m
4 ^! }# j$ t- _7 V5 v 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~* l8 U3 S2 E+ L
: c \/ z$ U3 b
七、结语
% h# O' U& ^: I; B! Z7 v vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |