一、前言* F! q1 }' r- E/ D9 v
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。- J- N+ e6 H g
二、环境准备
) ]3 r! H) m7 z: K- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g2 K: W5 J) s6 l3 a7 q' X' F
三、开发者账号申请4 N( r# `/ h0 \% e( E: ?
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。/ j9 j, W* N, ^7 k$ _2 U1 [* a4 {4 |
1.注册并登录 Azure DevOps。3 T' `+ N" D: V
2.选择或者创建一个组织(new organization)。
- G5 F: P) D, O% e% a- |3.在该组织下创建一个项目(new project)。
% s; w" r8 v: ~% Q; s% n 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
3 t7 z5 w9 u& F8 o
g1 r/ S; o! d/ q* p* ^) V
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。4 ~& ]9 R7 q% h1 S
6 a- N7 [$ A" x$ _/ y3 g; _
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。8 H% d5 [; u' D" a. R% ~: E1 e
三、项目搭建* F) {- w) B1 c
1、项目初始化
( q; x, c* O6 k3 F: M- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
1 o" ^0 d" F% ^* `3 X- }3 f8 n
4 E7 [7 Z: X' C3 k' z5 A/ m) f
2、项目改造: M9 L6 u3 k2 @8 N) A
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
$ K6 {' X1 M8 ? ?, X/ Q; H1.将package.json改造成以下模样:
( s+ B2 Z# e9 T' w+ P: y: C" ^{
"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包会失败。, @! ^% R% {* d# N- `! G9 [
3、编码 q6 v j& G1 T
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
F! G5 d( P: @7 j3 J2 B4 N9 s2 y{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。1 M0 b# j9 v; H. v5 _
四、调试
! s- s1 E% [/ B: C' O5 T1 A 单纯的开发代码片段的话测试和调试都非常简单:+ n7 N2 N+ R% k# f
- 首先先自定义全局的code snippet。3 q0 i5 N3 d. \+ y
# z" f9 N/ W2 m2 k$ Y- 选择新建全局代码片段文件。1 F: ~( `5 L, N
5 R6 _5 o2 H* d7 P- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。9 U( }& t8 k8 Z" U9 \* K8 D2 l
9 t: r* O6 c* _& Y! z2 ~
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
2 g, M$ v2 W6 m
- b) `: d. L& n+ F) E
生成的代码片段如下:
: C. x, M8 O; W* g8 v% T7 E; F 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; 五、打包$ N9 e. w8 Q3 i
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。2 R9 B: b( V; C' g
六、发布
# O7 D0 V* c! A' N. U) k Z) ~0 Q 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
0 w t5 ~* N7 Z& L' x3 J4 o& C
1 |3 W; b0 X; g' K4 y$ o1 b$ J 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
. P, M8 `$ X* `
# M3 b6 a7 j1 v3 E
七、结语
; |7 v( a6 ^+ P u, q' w vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |