一、前言
% b; {- M: |0 ^4 W- i9 k0 _ 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。( l$ T3 G0 B0 `
二、环境准备 6 ^! U% V$ g4 g$ a6 s2 c
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g, m$ k6 C" \' X2 t6 X7 }7 H7 W
三、开发者账号申请
% s% O$ m5 T- [% \0 i* X 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。5 Z1 l5 z( @7 X/ Q# E7 l3 A# t' c
1.注册并登录 Azure DevOps 。
1 T( p% }9 B3 x( d# H* W! ^ 2.选择或者创建一个组织(new organization)。
s9 ^" @9 f0 ? 3.在该组织下创建一个项目(new project)。: a% q5 p; Q/ F; ` z( K6 Z5 `" `
以上三步都是为了获取开发者(publisher)的token,获取token如下图:; \: J# |" X4 h4 O& \
; N* M C1 ]7 o; i Y/ E( \
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。2 _1 Q$ `: y8 V8 T* k
! O) r- q3 q0 t# k+ n% a: E. ~3 P 5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
/ [, L9 v* P. O 三、项目搭建 m4 z4 S8 I" t6 `$ v
1、项目初始化
6 y* w) ^/ I# L# I" Z% |3 N! G 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。5 D! P8 r4 k) @; I+ v1 R
+ r. ?9 P. p9 N! Z9 I: k
2、项目改造
' m. R5 P% J% N" h% o( ^0 G 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:% H+ _' w4 N2 T/ I( V
1.将package.json改造成以下模样:
3 F8 `# s5 D$ V2 c J0 V9 h& C {
"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包会失败。
8 b8 C: J+ f8 F8 p- X* W+ [5 g/ e 3、编码 $ n3 ^8 J, _5 z0 D7 _
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
) s0 v; R; P$ P0 Q* c: C9 \# p# _ {
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
2 n- Z3 _# S" r2 E/ d 四、调试
; r f, Q. _: j 单纯的开发代码片段的话测试和调试都非常简单:
" p, w) F* h. a ` K7 S 首先先自定义全局的code snippet。2 H2 B7 I$ s+ R' v0 G, ?; d
) c* ~0 A8 E+ x) ]2 Z! H ]1 G7 r 选择新建全局代码片段文件。
/ R" Y. e! J4 b% S
$ S3 ^( r" N D! Z; H8 m
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
$ C" }9 k+ i7 n
# Y1 d1 Y( e% n8 e4 | command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
u3 o$ Z H+ U1 k
0 U5 j* {/ c) Z+ y& f7 x. p( @ 生成的代码片段如下:1 s# W2 o) b. P2 L' r4 k
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;五、打包
+ I: ]% B& b# k$ K- _% p 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: @* D) R" l" U! v+ a
六、发布
, D# g: E: j9 Z# e) Z# X 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
[+ ]! n/ K3 o7 t0 ?6 `
6 S5 p' V5 {) C
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
5 j/ T1 Q0 G% Q! Z4 V( S r
0 \, ?& j( A! n% ~1 N# R/ p
七、结语 ( i4 Z' Z: c: c ~5 E
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。