一、前言
& x: b) y3 g7 T7 M 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
% |) C$ Q% R; ]2 j二、环境准备5 |- \2 H3 y2 J4 R6 o g
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
3 ?% z: t' T" I4 p 三、开发者账号申请
8 [, D1 {' |$ _5 `+ ~ 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。0 z' z: l M/ O+ q6 f2 E J
1.注册并登录 Azure DevOps。4 p1 f5 ]; H" R/ F! B/ o0 H
2.选择或者创建一个组织(new organization)。
: u5 r# R1 G/ }6 _" Y" [3.在该组织下创建一个项目(new project)。& H# |, e) J& o* s+ F
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
- U: z' @& E6 c9 y z
& C h+ p1 V2 `4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。! s& \: _% {3 F* }6 v8 o6 q
8 ~" }4 G4 [3 z# v7 g } X$ ?5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
% I0 U* M. G3 ^0 ~2 n三、项目搭建
' U- j% j$ t& a7 u/ T1 i# J1、项目初始化
' |/ w* g! _ J9 u% n& s$ c1 H- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。1 d9 e4 _$ Y4 m& E7 _/ J& G
5 X( h E0 Y3 F3 R1 _2、项目改造( x7 z5 H+ r& E2 S+ \
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
$ o; @, F) g, Z8 r+ @! T; E; b1.将package.json改造成以下模样:9 d0 C2 r1 |3 E0 {4 Z
{
"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包会失败。+ X4 q0 A* O. R4 o9 @# d
3、编码8 |$ C" W0 K z n6 Z
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:. u" }3 [) g J5 O; V( c4 Z6 x5 ?
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
" q2 P4 D: \9 V9 {- e8 Y四、调试
* }+ O2 \" ]% z5 C1 V3 D \ 单纯的开发代码片段的话测试和调试都非常简单:: _! Y* X% r% a. v' W0 X4 W# p
- 首先先自定义全局的code snippet。
9 R ?2 ~6 l- }8 X l
& W8 {+ X$ V# S# y6 l* j
- 选择新建全局代码片段文件。
4 B; [! _1 q4 X8 g
6 P. f$ k5 {0 u( @# i! _' N: I- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
5 p4 [6 [: P' l j s$ _
: h; z* ^/ P$ `3 c- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
* j. t6 y6 H) W. z
( q3 B+ h9 d5 `
生成的代码片段如下:
0 v6 E& E. r! zimport 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; 五、打包/ S6 X* H3 O; \, v6 n
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。+ r9 F, B1 f* D4 n
六、发布! |+ @% d/ B$ {; q& q7 G' T u
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!) b+ B9 I) J" U1 F
2 p% B) }' O6 G1 e 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~6 g- D) R+ g( o* M% M
( C f5 H# L. @
七、结语) e0 `% i. F: s% o8 g6 i& u
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |