一、前言
- m1 K9 \$ F2 Y$ K I( o2 q: c. C 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
+ M) M* A* F$ r1 u# M' W 二、环境准备
j; m" z9 X: d* N3 W# Q. L. A node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g; e' |1 {4 I/ Z$ U o; D
三、开发者账号申请
- H; p% h% T% N& v 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
$ h7 _% w9 O0 s$ e( ` 1.注册并登录 Azure DevOps 。
. H5 s2 Z/ |# B7 G 2.选择或者创建一个组织(new organization)。6 F! a" k; F; N; d s
3.在该组织下创建一个项目(new project)。) S& u: b4 d3 i* I, M
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
! p8 [2 z" z% S0 N% R. g
) w% B- I: f, N% @5 [' e$ j 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
" V7 @: ?' l1 \; u
( e- }3 S7 s8 }/ `) S 5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。5 R- @( d% o1 ^) b4 _
三、项目搭建 - _8 R/ d2 M/ F, Y6 u% A0 q
1、项目初始化 . @) k' f; a, }4 ^( Q ?' ~
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。1 j" g5 o2 k! v; h
5 y' Y1 l2 q, P) M 2、项目改造 ( ?2 r8 z$ M5 R8 z
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
D5 e5 ^: P. i% c1 p8 I+ d _& [ 1.将package.json改造成以下模样:1 R4 H, _. F9 t, i; N& c$ o' O! v x
{
"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包会失败。
9 X+ E+ F" V* u+ q" {% I# N 3、编码
y _8 L% [6 @* O: u D' E 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:5 B2 i- o4 q. g x7 v$ I
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
1 ?0 u, H, A' W3 F3 C 四、调试 & A! n3 D$ B. U* x1 R3 W
单纯的开发代码片段的话测试和调试都非常简单:6 g* S4 w0 C7 p
首先先自定义全局的code snippet。
( g. d" w9 g; R7 L P7 A7 @2 ?: ?
; D u4 A# v' d# Y, B+ p. m
选择新建全局代码片段文件。5 d/ c S1 x$ ?2 V' O
! A( e+ S3 q8 ?4 o4 f1 x9 o/ j7 | 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。+ R3 U# }7 [2 |! d" k5 E
A" ?+ [1 l/ R
command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。& ^4 {2 G# O% z% Z3 g
+ ~& d( E" s7 H2 k
生成的代码片段如下:" T8 D4 e; ]8 L- q6 U
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;五、打包
5 @! y& Q1 @ U# m* M5 l, | 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
& v# F- P9 ]" o7 w; J* J 六、发布 + ~- G. J* V# \
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
6 A4 ~' h' Y c2 M. q, v
1 I& X+ W! o" U6 r- e" ] 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~3 G+ m6 @7 j) x: r
+ M7 e1 }" a+ P% U5 t 七、结语 / H1 E4 i/ @+ a/ J
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。