一、前言
3 F* ~; ?* ?% ^" b; h 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。0 p! b) L( U* s4 `, ?
二、环境准备- D( t& ^; }4 U5 O+ F2 S
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g, d9 ~. [2 S: u. t& Z( ~6 B
三、开发者账号申请
) J |: A" |* ~; z4 H 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
; G# Z3 D9 p+ R+ m; V; S( g. h1.注册并登录 Azure DevOps。4 {+ S8 ^7 e, u/ t2 @+ E: N. q% y6 H
2.选择或者创建一个组织(new organization)。 ?3 Z5 g7 Z) Q' N% e* K) }# z
3.在该组织下创建一个项目(new project)。
; R6 A! ] g) B0 d" I7 B 以上三步都是为了获取开发者(publisher)的token,获取token如下图:. G1 W8 b+ k" ?" o6 T) n
6 b, P8 v5 |# }4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。 L3 L- d- ~$ G
' Q; s) d4 @6 k- \5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
- ^, P4 n7 ^1 d4 m5 M; {三、项目搭建
* {8 [; E" x5 U! O0 a1、项目初始化
$ Z n" I3 N5 p' p7 [! H9 \* g- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。. J: Q9 `* F$ ~& W
8 I9 t! k U% [0 b
2、项目改造/ [! X3 \) L, U7 ~$ M' o1 r& q
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
+ I/ Z R8 g* s7 M& B1.将package.json改造成以下模样:$ M3 Y8 f4 y f6 n# I* n
{
"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包会失败。
0 f! n% l B9 C6 Y& j* `8 ?8 ]3、编码
1 r# _( i" ]8 j* d 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
; P. n! d5 d6 g& Y" m3 i% x# @) r{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。* m2 V7 K* U; J7 C% ?5 o
四、调试
3 h; d; i7 x* v 单纯的开发代码片段的话测试和调试都非常简单:
- Y) G k+ t1 ~6 k4 o- 首先先自定义全局的code snippet。
% Z7 n% r" w+ t; T
$ U; ^2 t6 I1 ~5 ]) L5 T; h4 |* X
- 选择新建全局代码片段文件。) _( q1 Z* m& s+ o6 b* G; ?
% q% z* P5 s: d- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
! N% w5 u& t: x" `1 ~& c
* x& H* `3 F; n; w; |% ]
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
3 Q' J' l: B; U
, E \! ^0 g) L 生成的代码片段如下:8 [, d9 I4 R& I/ R) y* E$ o
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; 五、打包
% {. f0 ]" [+ g) H% L6 r+ b$ ] 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。! Q* r, X0 `) q+ {
六、发布- ^- r! h- }5 @5 m/ ]! {) q" `1 @
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
9 T6 O0 u# h8 a/ o) j8 f
- A, M r6 }$ P; t4 e" B
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~% S) ^1 b8 W3 i) P* U
* w* S' B+ u3 l$ S/ f+ N
七、结语
0 U+ s% J8 ~3 H vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |