一、前言
# s5 |3 N2 E# P8 x5 l8 c5 { 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
5 w: o- R* r$ j) I9 x二、环境准备
2 f8 o/ `( p' I6 j. M/ J7 `- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
- t) V8 {: J; o 三、开发者账号申请
; ~) j& V4 l7 B( r' B 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
6 C0 q6 K$ _ @4 O4 i1 W1.注册并登录 Azure DevOps。
+ G& l" V# F5 A/ r7 ]: [- V2.选择或者创建一个组织(new organization)。
# `" P# t5 W7 M! k: G; w3.在该组织下创建一个项目(new project)。
. S$ k, J+ O: M" C- l 以上三步都是为了获取开发者(publisher)的token,获取token如下图:6 M% ~' z4 o/ S ~' |7 |5 H R
6 K* R+ Z' P+ H% F) N3 T) ~
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。! J2 J6 s. ]% L& O. T7 u
H) R5 n0 Y6 ?1 q$ D9 Y
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
0 U) U" K& Z2 y* ?) l, ~5 [三、项目搭建6 k3 W0 C; e2 P) J; Z5 J b& C
1、项目初始化
$ g; O1 y" _8 L- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。0 r7 Q5 Y2 i# Q$ i* h
1 K/ @; Z; t2 h5 Z. h: b, L4 s2 r5 B2、项目改造! {! u, M- H6 U* m6 q
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
# ~* o6 `* |8 `/ s( u1 [! f1.将package.json改造成以下模样:
; o0 B0 w7 U' f8 y6 R) r{
"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包会失败。
& i( @& ?1 k+ F V. j9 V. W3、编码
( L3 u: }* p0 `2 y. s& v6 u+ m' M) g 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:) x: y6 L- m" ^- q& v7 ~
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
# t% L7 M- @/ H: }; A9 U5 N四、调试
* E/ p1 R' [( o6 T2 i8 g 单纯的开发代码片段的话测试和调试都非常简单:, r" I, j7 e! _9 g2 f r) f
- 首先先自定义全局的code snippet。- O$ y e4 |$ C; k
1 ] [) |' Y( E. ~5 n' `+ p1 j- 选择新建全局代码片段文件。
( _+ \5 s! l. V
- u" ?! L5 y) i. q8 a$ B- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。% s4 z" _( ]% L) i$ n5 J2 z
2 x4 n, h1 {7 J8 z- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。$ A/ E' p1 ^& ]5 i* d0 h; e! t
# i; X6 e$ U9 H& v# x2 [ 生成的代码片段如下:, K6 z8 R5 m. u. u# k, \
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; 五、打包8 h$ [" o0 I& | K
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。7 D6 m) n5 F; S
六、发布% j9 G+ ~$ D. s1 z4 H
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
6 A/ b6 L( w. S8 b0 s
! q) ^& q8 g! q8 _ 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
& I" p6 o, I: ] Y9 O4 t
3 A4 |+ X6 V3 f
七、结语
C f" X+ E, [7 `: ~$ B vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |