一、前言+ G$ F; T% Z8 r5 f! k* v% g9 J3 K4 E
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。8 j# {$ L$ T& ^8 t
二、环境准备
, q0 g' n% f( g% F0 w. O& b- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g& k" o: V/ ?6 g! Q. s9 y2 S
三、开发者账号申请4 V2 L6 u9 a, H8 o' D, i0 `
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。) N% u. c7 B- P8 ^* W) E
1.注册并登录 Azure DevOps。
6 K# [0 F9 P+ v2.选择或者创建一个组织(new organization)。& K+ y; t q" Y& N8 v
3.在该组织下创建一个项目(new project)。
' Y$ t# R( G2 j* d" ` 以上三步都是为了获取开发者(publisher)的token,获取token如下图:# a& V; s9 {: ?$ ^$ A$ j1 F+ _8 g
- j" r8 a X9 O5 }
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。, R" i9 [6 F" H5 w+ F
5 E3 B& p- N/ k: p' a1 s0 Q
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
. X3 R# }* V5 h9 h三、项目搭建4 p/ H2 _5 p0 I% O, o
1、项目初始化
' p$ [5 A: X/ [; {' d- g- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
' I! H% X; U$ Q1 C k4 @
6 ?4 K8 P/ W. n" y4 h- R0 Z: u2、项目改造% ~5 H8 J$ ~) Q7 m( W
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
% }8 b6 R+ C' {# Y* j( ?9 s, f3 Z1.将package.json改造成以下模样:' M1 U; U }+ \5 g- V& j( q
{
"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 L; a1 M+ N {. ? r: f% S
3、编码# }1 g1 l1 W' s9 w* m0 ]
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
* j- @$ B; E$ U9 p; `! 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
6 [, ~2 j3 R: Y: h/ u# l/ Q& @; o四、调试
* ` [2 y' |1 F' F, F 单纯的开发代码片段的话测试和调试都非常简单:
& {5 }0 ^8 _9 n0 k- x* N W( Z- ?- 首先先自定义全局的code snippet。) x7 y8 Z+ F+ {. M
- i# O, e1 |# \8 o# m1 r8 B& F
- 选择新建全局代码片段文件。
( s7 o/ Y2 c6 s M: s8 W) J$ o
' c/ t! ?: F( `8 P- `- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
3 C, ?, w/ l$ ]- e* G; M
0 r. A8 r3 t; L- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。1 |2 |8 E7 U, q; b# {- L, M
8 Q7 Y8 h7 i2 e( @* r# w 生成的代码片段如下:1 h% E+ d' l2 q, t; A# @5 q
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; 五、打包7 j8 I7 k3 ]& X' |9 X2 I$ [
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。) P9 S+ }9 U! C2 _; a( ?
六、发布& B& M/ U* A# _0 Q
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!9 W+ k( P8 n8 F- N* W% n- ]- A
* ]$ T4 o6 R7 q M3 L& L9 B1 U
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~/ u* S4 L% r& ]* H& m1 X4 r
/ U, s" }9 B% |1 ^6 \/ Z6 J
七、结语- P- W: I6 L# n# u5 M' r
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |