一、前言
; q6 K7 F, O7 Q+ d+ i+ q 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。( |: b) ~. Q$ [ `9 k( {
二、环境准备
# V4 \9 Q, n) c4 v2 y- H* H. a, C8 `- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g' P, W& m9 x$ w. N
三、开发者账号申请
* ?, B" J4 l5 q: V% M 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
5 W5 d4 D* L' A1.注册并登录 Azure DevOps。
. v, o+ r& ?1 s @+ z; u' l2.选择或者创建一个组织(new organization)。
9 W) y+ I7 T5 o- ?8 q& b+ b( s+ B3.在该组织下创建一个项目(new project)。
) ^8 M$ d3 C) R. q 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
+ z# `. Q! X3 }2 l5 a7 w2 S9 b
1 h/ A& ?+ o0 f5 x8 b% Y; B) |, k4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
9 w/ z; m/ y" O% |0 R
/ M3 r: S/ U$ {: l& g! `5 W& }5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
; Q8 \# S- p5 ^2 u v* h三、项目搭建9 r# s# B6 D! H2 b3 w8 S9 `
1、项目初始化3 w# w' Y; u$ R( |2 }- u' E: E
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
: R+ ]7 T4 w+ S2 U5 J0 p/ q
0 U. d- Y* d$ Q% H- q |6 {2、项目改造- K- h% q" k* x! m( G6 ^6 }0 n6 o5 V
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
. f7 x2 D9 N% t6 I& w+ `1.将package.json改造成以下模样:. {9 g+ h: X$ G" l+ ]/ ]
{
"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包会失败。
7 v' }$ ]# y* r7 g3 i0 t3、编码% d$ z k, S- ~. T# j# ~" `. {/ G
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:! k% S8 h: o+ _5 \& j
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
8 `6 B/ c+ F3 v四、调试
6 e6 e1 x5 [# ^2 ~ 单纯的开发代码片段的话测试和调试都非常简单:
# H7 N# [% i- k2 W/ i5 @- \- 首先先自定义全局的code snippet。% I$ t" [2 [" j" M. |( b
$ n0 w9 u1 B' G) u# B
- 选择新建全局代码片段文件。% t4 b$ X5 E6 R% r8 \& z% ^
) |) J' B; p8 l% {0 p
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
* n5 H( h9 B3 q, w( Q( q- R. [8 m) ~
7 K5 w. h6 k! o
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
h; u B W9 I" O" U; d3 U. ~) K
9 c; m. p" Y- H6 j9 ] 生成的代码片段如下:# o/ R1 a; V8 R4 i7 N; \1 H
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; 五、打包
4 {9 D @# J+ u# O5 `; R, }. m 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
7 A# y' n: s6 S2 Z六、发布
8 B, _# _4 c# \. n8 e4 { 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
' ^7 t/ ?+ Y" _! Z* I5 Q/ d6 n9 R
4 U1 k5 n3 ^3 H- W! f
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~' T$ E% C0 S' O4 T' k7 [
: e+ _' q8 A: ?9 H) ]; c七、结语
0 A' M. _$ k( N. Y; f vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |