一、前言
; |; w( K( l1 _* e: E* [2 l' r 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。2 t( _% u+ b$ s' |3 Q
二、环境准备: D$ l8 g; [) M" [/ v3 a0 _
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
. i f: V; P1 ^ 三、开发者账号申请
0 @5 h# A. J# r! m% N+ X; k 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
+ w, X$ i6 Q$ b/ Q" e1.注册并登录 Azure DevOps。# r' L5 L, h, R& B3 b. i5 l
2.选择或者创建一个组织(new organization)。6 \3 i' } f( E& _& ?
3.在该组织下创建一个项目(new project)。
7 s2 f# f: U i) O. P% e8 a 以上三步都是为了获取开发者(publisher)的token,获取token如下图:' k4 |4 \4 D& w! P; `5 y( S4 H
7 \& x; `& e6 m8 T4 w# o$ R+ C2 E
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。2 d6 \, ?* a1 `9 [0 z. L }
% {2 q6 C y; y! `1 Z; X! d3 T
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。2 e2 A0 m+ Y( @4 \1 I1 q
三、项目搭建! W, v K5 p8 t& x) ^% u3 J( a
1、项目初始化
6 A5 y7 O) f1 |2 K4 ^5 Y- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
3 F: v8 d8 W6 s7 A! n
' C' v+ @' h9 c/ X! Y
2、项目改造
y i0 y/ J; |* w9 b4 q% q 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
, ~$ r! f' |* H9 E, }8 z1.将package.json改造成以下模样:4 G9 T2 x) L2 {
{
"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包会失败。% k3 j- b0 c) T- ?. e4 @, `, ~
3、编码
3 C8 J8 n" C2 B% ~0 A: o 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:8 V6 c' Z- ~# B8 k9 T# I& ?
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。. w4 U9 u( C7 Y% |7 \ W
四、调试
& M2 v5 z2 `# ~) [ 单纯的开发代码片段的话测试和调试都非常简单:6 {$ C8 f! [( h+ U
- 首先先自定义全局的code snippet。
9 C$ y- m) A$ d3 e% s9 j7 Z1 ?1 e
+ H( ^" X9 @2 s, G5 S
- 选择新建全局代码片段文件。
& Y: {7 ?* y& p5 g/ N
" R Y: a/ e0 B% H2 e- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。# @3 a1 M$ i) n& t
! s f) g2 F& B% {4 J. X- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
- Z/ ?6 L, t# _. [8 _
" m" T9 P. W- F' O5 f) S, l 生成的代码片段如下:
7 P7 ?7 B+ c- x/ a/ r9 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; 五、打包
! u, ]* N6 U3 h# ?$ S! x 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
O0 G( l3 a& V3 D& U六、发布
) `- _8 m' f' ?" d 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!/ v. g' r0 E1 R
8 |( H- T$ } Z
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
! \- O; V) B3 [: w8 R/ }
& P$ o7 z3 q2 J/ [
七、结语
- c9 `+ t& M7 z9 C4 ]' m vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |