一、前言 & R% c+ o( m. q9 `
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。* k% q& h- u- Z
二、环境准备
0 Y/ Q" m+ ~" x( E( h' C) \+ Q+ } node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
! w$ |2 \5 z) l 三、开发者账号申请
. q" S0 b6 m# E% h 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。4 G4 p' e; \% X% S0 ~ y' l
1.注册并登录 Azure DevOps 。
8 T' ~; \9 j% R, j. R 2.选择或者创建一个组织(new organization)。' I% R1 y' O9 B m
3.在该组织下创建一个项目(new project)。
5 J8 t* o( E; C$ a/ I# s* `! R( F 以上三步都是为了获取开发者(publisher)的token,获取token如下图:0 Q) V5 U6 n7 D$ A
: e$ R! J/ F% V0 J0 f. {' P
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。/ s9 ]/ K$ p& i
) _# g+ O) Z% v: j) b' O 5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
* j, z/ y1 o3 T 三、项目搭建 $ D, l5 u. F8 r2 [8 @/ U$ j r$ P
1、项目初始化 ' R* T( A! c. I1 F) j4 P
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。4 g6 L: d/ _1 |( y& s! I; E; ?
/ u6 B9 O0 s7 ^$ P( D O
2、项目改造 6 U% W% Y- X/ P* {0 M. F1 a( @
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
; _+ T' M5 k; \: |, z; r 1.将package.json改造成以下模样:
2 r. U" n8 |9 C& @) 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包会失败。" V, i- x; ^0 V, r% ?
3、编码
2 _( ]- ?+ O9 q2 M 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:: c% t2 `2 Z! b4 y
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。$ R- R) t7 J; Y0 K7 K
四、调试
0 y8 `: X8 I! i, F I 单纯的开发代码片段的话测试和调试都非常简单:8 f! u0 M; B5 J
首先先自定义全局的code snippet。: C9 I: {' t4 f5 A" D2 e
% W- S3 l, S, `) X6 u/ J
选择新建全局代码片段文件。
+ J, p# d9 x* n0 g
: B" V- x" h' l1 x* j" n( ` 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。' m. p1 ~* q% g# [& n
3 K B2 Q+ u4 t A" Q command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
7 y6 Q" ~, q/ V. t! x* E0 z
7 c7 e6 | q3 F
生成的代码片段如下:
_9 H* s i& v H3 \$ p0 g 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;五、打包
7 p" f' N9 Q3 X Y% [ 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
+ p( _# Q* O) ? 六、发布 ' w1 k! X) O$ q& \4 [: \7 J
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
5 w& S) Y' x# E" `: s9 u/ }
, N8 `/ Y) G s1 q' S
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~* ^+ D2 P% I6 w
4 M0 K8 m4 ~9 q C/ T8 A 七、结语
. R9 Q6 g" k, e7 I0 C vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。