一、前言( X( g! D5 K( ]" |5 m7 @5 |
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
( w0 \( \" L/ I6 H8 q6 D3 C二、环境准备
( P( u. u3 z y3 O5 Z# ?, u2 M- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g& [6 g* j1 m/ `& t$ z' ~. H j
三、开发者账号申请
: D/ I& _; P: c% F: J) E% N 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
% [. {' d: P3 a1.注册并登录 Azure DevOps。; ~7 A1 C4 w- j
2.选择或者创建一个组织(new organization)。
9 f/ U6 R2 F3 ]% v8 u2 `4 W1 [3.在该组织下创建一个项目(new project)。; M/ u$ p( o7 J( q
以上三步都是为了获取开发者(publisher)的token,获取token如下图:8 @ `! u, c2 h- O. b/ S# I
: j( E8 U$ A/ z6 J; Z4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
. V0 Q* L1 _" T9 N0 V: O3 W7 `. a
* P6 I+ [- K5 A' d5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
/ j+ r5 Q5 V: k! I( w/ |9 G2 ^三、项目搭建
. u. A8 D4 p/ j0 o, S1、项目初始化! o& s4 g4 w. m M" E3 d! m4 o: a
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
( @. N9 l1 b% z/ D4 S5 S- K1 g+ N! ]6 E
' a# R: M+ W5 l, ]7 j" A2、项目改造
8 G9 _# k$ u a( }8 w 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:7 f; z S4 F3 K, A4 u
1.将package.json改造成以下模样:
. e4 S' E4 Y: u& A* H& 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包会失败。
0 n0 e8 S% t0 g3、编码
' w( _% [ ^! E: O 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:2 Q2 @: |& P D' m" q
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
, U. F" ?% [+ h四、调试4 G$ q9 z8 K* i
单纯的开发代码片段的话测试和调试都非常简单:
6 t8 B) `- u4 j( D+ Q- P! b' m$ S- 首先先自定义全局的code snippet。2 ~! H$ ~. P5 {) T
$ Y H# k: ^0 _- 选择新建全局代码片段文件。
$ H! t: {0 l( B- z
; y0 r7 G$ P, `( ^1 p5 R
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
( M! `! C& z/ `9 e1 P
2 E2 J0 B, s m; N$ \# S% c, J- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。 N# ^& I- C( G* g9 i5 \0 g
: J, n+ R' @( \$ E- x) D 生成的代码片段如下:. N. [+ D. h% L2 K0 R7 f; c
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; 五、打包
; ~( A8 N$ X$ [ 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。4 |& ^& F" U1 M) f1 d
六、发布+ T O! B8 R- l
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!( O5 m' d3 q. Q" A# p0 Q
) h. P, l1 e; ]7 d7 @& a3 A 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
! ` t; D/ T4 y6 }) } b
1 h3 O2 B. G9 B4 w
七、结语
! E& N& O) o$ U9 P vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |