一、前言3 A" U/ `8 f# g; y( B g4 p- v
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
, g! v4 I% l3 x0 L2 o( t, }- @" Q二、环境准备
& ^4 O4 f5 P" l6 z6 W: _2 w- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g: M/ g& h/ g; z! s; h( E' \* {
三、开发者账号申请# Y; f; t3 H8 D
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
$ K& m7 W8 u+ |4 Q# Q$ E1.注册并登录 Azure DevOps。+ a! v2 W# `( t
2.选择或者创建一个组织(new organization)。
4 z* ]( Y. L9 e/ l8 t9 L3.在该组织下创建一个项目(new project)。
* H) A- D! |4 D$ V$ F% W% C4 P) I5 W+ Y 以上三步都是为了获取开发者(publisher)的token,获取token如下图:9 O6 d# \! H; Q, j. n
0 \ c9 s! b2 K8 `4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。4 ?# G+ P, ?: O, U. v
' t& B2 k- `' J( J- b& z# K. n
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。! [, W) T9 R, |" ]' \# o/ \
三、项目搭建
( ~& M3 z- Y7 \! L/ D1、项目初始化
" V6 C. y0 L' O( v) T: F' f- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。2 n8 [: A& q4 f6 a) d
% |/ s {* H$ l4 m- Z* o& G" C& W2 Z8 _
2、项目改造
/ u5 _% L0 f4 M" Y 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:! y! R) v! ?' P. T2 Y' G$ [& k
1.将package.json改造成以下模样:& _' ]* a* w, p6 B n6 _$ i
{
"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包会失败。( E5 L! k" u) E6 D8 T5 s" C- K
3、编码1 Q6 K6 O6 f7 q
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:4 H; n. i* Q. ^0 K
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。" F/ Q- S5 \3 k, e2 g2 T9 u
四、调试
6 } Y9 t6 {7 o$ j 单纯的开发代码片段的话测试和调试都非常简单:
' K. T0 Q% P& ~* R' h) S. B4 j- 首先先自定义全局的code snippet。/ N( V6 y; g7 H+ U. V! T
! R) r/ D0 h- }# O+ {* m- 选择新建全局代码片段文件。" U2 p3 r Y; O' _' I# G
0 W1 J* `* [# v9 `2 P
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。' |% r7 ?8 ^# n7 L/ l) ~; x4 a4 O
8 R- R! x5 O$ b- v) w1 H/ `- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。& T. m" z' F* a
: A$ {* q" F% s: e7 O
生成的代码片段如下:
% K# o- b- [5 Fimport 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; 五、打包2 F7 z7 d% t& |6 s
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。. u5 `. o. r- p1 @9 x# a
六、发布
1 p) I0 D* u- x( ~1 U- {+ ^ 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!1 @( _: `+ b; ~5 ^* Z
/ |4 T# K/ J0 N# I. W
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
% a5 l6 e. w4 K' G
3 A* y: P v1 U( b9 t& W* r6 R
七、结语! R, B4 L. R, }' m2 q7 {& P
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |