一、前言
7 s: `! P0 |) Q( B3 D 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
5 V5 y. h7 k7 G& u8 A二、环境准备
. `0 l0 e# Q4 V9 s" T+ y1 ]1 W- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
& c4 U, T2 l% b( o" T, d* } 三、开发者账号申请( t0 s5 q% h" ^7 O
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
" d" X. |, K* v% ~$ W1.注册并登录 Azure DevOps。0 O* n$ K3 X0 \1 C- @
2.选择或者创建一个组织(new organization)。& c) G) P1 M. t# f; m- Z
3.在该组织下创建一个项目(new project)。
* D; |+ Y6 I/ k6 r7 M7 {* u* }* q# Q 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
" _% P; B: X, c K) R \) B/ i+ g
( {& v1 ` w1 F8 S( z4 V4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
3 A' n/ l5 z. i$ Q9 z# [
6 O' R* f/ }* I( i
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。# H7 d$ T0 k$ |- q
三、项目搭建
9 T- ?; X0 F9 v7 P" I% h1、项目初始化" V4 ]3 h. [8 C) M( @: \
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。$ J2 C% d; e- c3 [0 S. l
; m0 U* D4 B+ p7 | _) k
2、项目改造
' P9 [" S; l# a8 X, ~; K6 t 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
: D1 U, L( D1 d* `& z* Q9 [) ~% y1.将package.json改造成以下模样:
( c" D1 S# w4 B/ N* M$ |* ^3 v$ O{
"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包会失败。
1 l5 M& [4 u! l3 R3、编码
9 ~4 p9 f% ?1 V6 D1 ]& a0 G2 K 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:6 c- q; z, J x3 l
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
: x$ R0 [' l* }: Z. q" Z+ C四、调试
3 J& y, K3 b0 [. g 单纯的开发代码片段的话测试和调试都非常简单:$ c" M7 h8 A O8 X3 _
- 首先先自定义全局的code snippet。
. i' h2 {2 I. p8 U
0 l# h8 K) H# x' L- 选择新建全局代码片段文件。
' b9 U, @' ]. u0 q& e, z* r" g0 U
% J/ i- L; b n1 ~- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。5 _$ T/ r/ ~6 G' R( ^
5 N& U U' ?0 M( h- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。- H# l, x F: N3 x$ j
3 D( ?, Z" N, m! W0 {6 {5 o
生成的代码片段如下:
4 g; C$ ?5 ^( ~9 K simport 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; 五、打包' Z _7 ^$ r! l
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。, b, Q" r! L6 g- {( a0 M6 |7 k. ~
六、发布
# n2 K, `6 O1 Z Q$ B [ [ 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
9 I9 ]) q. u: [+ U9 N
9 J) n. i p. z
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~: u3 p4 g) q4 Y, h9 E3 a1 R7 u2 v
, l# s: \+ ?0 B( u: @
七、结语 P) d) m9 z, Y+ ` ~2 K0 n. _
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |