一、前言5 Q& |; v; F2 g: z7 S/ E, I
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
$ e- V" l* E; A. x5 L二、环境准备
" N" P% ^! }8 `) ?' r- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
! A' O1 {1 c; a) i 三、开发者账号申请
5 T0 F4 w7 Q5 I# S$ h" [; A 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
6 ^6 |* d# d7 X7 x% y4 a1.注册并登录 Azure DevOps。
' j6 c- B6 c) I5 _; s2.选择或者创建一个组织(new organization)。
) n4 Y- S" U/ H( z0 u- d3.在该组织下创建一个项目(new project)。0 c/ d8 U6 J2 r7 s
以上三步都是为了获取开发者(publisher)的token,获取token如下图:0 F/ E3 x7 _* Y2 v
( _2 j# R% v$ i; W, {
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。. W/ ]! A$ t) h7 r
7 r) n7 T4 p R2 }% X' G* m5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。# J! Y3 T* c4 ?
三、项目搭建$ s' w/ I- L" X1 _/ o
1、项目初始化; e- Y& C! L! g+ K- _# a/ _; c
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。9 Z: R% f7 H4 h9 S9 I) r. H4 F m( f
( z4 F" h+ n5 E7 E7 \. G
2、项目改造
; B7 J7 `5 b- g! | 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:0 i5 G' k) z' {6 q' ~/ Y; U
1.将package.json改造成以下模样:6 v8 X3 T: ?7 M% O3 k
{
"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包会失败。
5 H% X9 U {9 @ n3、编码
0 B% q% a! y' _! m2 A% y& y 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
0 S5 Z5 m* O4 D7 t$ p7 _{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
5 @% r" M3 \( j/ f9 P2 L四、调试
0 N. u5 L; T5 i% e* Q 单纯的开发代码片段的话测试和调试都非常简单:
" Y; k3 F7 W1 |5 [4 z4 S- 首先先自定义全局的code snippet。, j: X3 i: A, g8 ~* k& k+ Z
1 S# {% V5 i7 h( z$ n
- 选择新建全局代码片段文件。/ v6 c) V7 d: a# S) U
8 b& b( r7 O" z0 F# A
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。9 M. X o! n) w
0 I, C. ^1 p' U% |: s- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
& H- ^) T, j4 K! L! @1 Q
) ~+ }+ J2 V+ M3 E% e. W4 b V6 \+ k
生成的代码片段如下: Z7 }& o/ [5 z
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; 五、打包
; n2 O( o* |9 q( f3 l" U 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
: _4 r, E& t9 D; b六、发布 s, \% n& [. [4 O9 G" q1 `: v6 z
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
0 [4 X2 o \1 b/ c( M1 v
: P3 P; i5 o6 ]0 \" r4 ~
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
# _6 f9 |" X9 v9 t5 u! y
+ q" v* e! C2 D% @9 T8 K. U0 `
七、结语 k! i' z+ V' [# L
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |