一、前言3 y4 k) k- ?! ^1 w4 e
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。8 J9 z0 j4 R( m* G$ `1 {3 ]% H
二、环境准备
" \3 w2 U; [, r) e; n3 u- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
' |0 i0 O- |& X- ? 三、开发者账号申请1 {3 g" T2 h2 E
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。; ^) j8 Z4 T0 b8 |5 ~
1.注册并登录 Azure DevOps。
) M7 b/ P( J2 c: ^6 V5 P1 y2.选择或者创建一个组织(new organization)。; @. `- G! X4 x& u; E8 p' v. `2 Y
3.在该组织下创建一个项目(new project)。, L* j' T& z5 z- A2 r; {4 h
以上三步都是为了获取开发者(publisher)的token,获取token如下图:- a% h: q/ `1 c, X( `: ?8 p
5 K1 z$ c* }0 s. j3 C( F7 o2 y' X4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
* m$ p$ a4 \4 y7 w+ i8 S* l1 w
t, q2 [6 M0 g. }8 o. ?2 X D5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。4 {; M: r4 r1 A0 [
三、项目搭建" c O# z5 y2 Z
1、项目初始化8 N* g+ }# I( o
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。8 q( @5 k" f" d$ o4 _* z* @
) w( d9 F" { i
2、项目改造
& V+ y( @" ^- \* f; w, S 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
W0 a/ Y u# G1 Y- B: U9 z* u1.将package.json改造成以下模样:
9 U! u0 Q% ~2 Y: C, U' T{
"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包会失败。) {' ]3 i( z( T |
3、编码
8 r4 Z7 B& G0 K7 j 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:' S. ?5 d. u3 d$ v
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
7 O/ U8 i2 i" `1 |0 P7 E四、调试
; B9 v/ I+ i5 O- d 单纯的开发代码片段的话测试和调试都非常简单:" c8 |( O! V5 o; @1 g
- 首先先自定义全局的code snippet。
6 l5 t( w F# W
8 o" ^0 z$ `6 g$ L: k9 m0 _
- 选择新建全局代码片段文件。! u/ ?: G. T _
0 A& u8 |1 \/ J$ }" w, Y* q* Z
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
5 O1 R, w2 H2 y+ {; ^
9 c) C8 Z6 k$ V- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。+ w, R/ t0 S0 |% g
y# y) ?- G# J4 C1 c 生成的代码片段如下:
+ {" ^+ X, b2 a5 \: vimport 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; 五、打包3 b6 Q+ m- G" k* x8 I: s
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。9 l5 u+ N! Q% K& O6 f; i
六、发布6 w3 [1 _) l" G) l! J8 d' i
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!. d# V6 D2 K0 k& F9 B! z
; o8 {# V( ^$ t' B4 L
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~) ^$ \9 r2 c0 _3 Z: p2 n# s
* d# R5 g- f; {
七、结语& @ P* u7 k) a- X& }, N+ M
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |