一、前言
8 c" h5 P; g' ^1 A2 R/ D 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。! O% f! N" D2 r0 F1 @& V/ X
二、环境准备% g* O" \. _! q6 w
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
+ n) u- k. ~' \) @, s( x- r6 l7 _$ E 三、开发者账号申请
1 j+ K1 J; C& M5 C* n 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。& }4 A- M6 ?! m0 g$ g2 ]
1.注册并登录 Azure DevOps。) L! z7 W. E8 I* \5 l
2.选择或者创建一个组织(new organization)。
; e/ N2 K' D" A: T3.在该组织下创建一个项目(new project)。
: ]' X! Q) T3 W6 f" D: _( d: z 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
& J: U' N% d( K. c8 ^7 W9 L6 Y( o
& | ^* P# l2 W. w; m4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
( d7 M( @$ B1 v8 F
_+ r3 q+ B; Q- w; |4 ^* s% d5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
) ], I5 p# P. b. K* u* D9 }3 l/ G三、项目搭建
0 H# e. e2 R, S. r1、项目初始化# b$ _& v5 }3 H4 D' u
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。( A0 _* B/ y+ }2 @/ m4 `
/ ?* } P& {) x
2、项目改造
0 C& b1 X% M* h) u M. r 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
/ H5 y% W. C$ h1.将package.json改造成以下模样:
+ ~2 E! `$ T1 x% |: |8 v+ J/ E; ^ [) J{
"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包会失败。
6 D: a% |' {/ e* @& A" A* R3、编码$ L* n4 H F$ ~2 X& M/ T$ L: {
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
% `+ D# L" e6 Y- F+ Q% w{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。( L1 q' O8 o3 r. w4 Q
四、调试5 M& d- f: r# y$ E) E7 q# g% D
单纯的开发代码片段的话测试和调试都非常简单:
7 ?9 m ?! a q- d7 T- 首先先自定义全局的code snippet。
0 _% L7 \. Q! Y: f
- P! v6 ?- I4 l7 e$ s4 C2 V! M' w x- 选择新建全局代码片段文件。
( a P, R3 s7 D
2 R7 I& _1 v- m5 [( g0 L
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
' e7 W# b; c2 W5 o c8 M c
3 |) z( Y! H, X+ U- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。 b8 C' K1 m6 n3 |2 `9 T+ l# U
% |# O$ z7 y9 D% J- Z- k( {6 q
生成的代码片段如下:
1 S. J7 \$ ^% w3 R- Aimport 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; 五、打包* _2 P- ~* A' ]% @6 G
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。2 |$ e( |0 o m0 |3 I9 e) H
六、发布
( W( e n2 q- c' c! R" n. N 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
' Q8 P* B: f& N7 N# g& J" s- K' }
9 F# ?5 F5 J6 x( ] 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~ y( P( T/ G4 e% G' M4 ~# x
9 w7 U/ g. F' O( y* m七、结语" \( t# g0 g+ P
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |