一、前言
& n9 l4 |) I; i1 Z3 ?3 N; u$ t" D" [ 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。6 `+ {. j4 K0 W& z
二、环境准备
3 H5 q1 Y* G. u: D node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
7 F& y W; ^! G 三、开发者账号申请
4 o6 T6 z# W$ D! o/ {2 Q9 g 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。) W! }* _7 h h# C' ~
1.注册并登录 Azure DevOps 。
1 F" s9 |+ Y; X 2.选择或者创建一个组织(new organization)。' O* W: z W, h* d, T4 J5 Y: L
3.在该组织下创建一个项目(new project)。
4 a% r6 d- M# `. e! B+ w3 j 以上三步都是为了获取开发者(publisher)的token,获取token如下图:! V, ^' S& ?/ H1 s$ {" Z* H+ V
/ l u. x% m" f) E. ?
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
* @4 I( A, M, U1 o! i
5 e% V: T: q) o8 {( o; W
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
# e' x4 L( j6 S* d 三、项目搭建 . N1 l, m9 s4 J0 p! V+ R9 }9 Z
1、项目初始化 - h- r$ d/ _( a! r* p$ p2 m0 H
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。% l4 y! |) i( K
& z: x' e% y: K2 K
2、项目改造 ! d: F2 j$ X6 o& z/ N2 i$ B
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:) Y- u! p4 ^( O* F& U3 l
1.将package.json改造成以下模样:: w9 t0 ?% |3 S# m; `/ 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包会失败。
5 B4 c& x* Y! N3 E8 x2 F 3、编码
4 [ X. R! E0 u4 S7 Q 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:) j+ S0 X* f2 n! B3 }( v
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
# U& H( l# g5 x( j 四、调试 - L0 s; u9 I; e Q, a( \
单纯的开发代码片段的话测试和调试都非常简单:: m% a& p5 C3 Z: z6 b; A
首先先自定义全局的code snippet。0 {( [6 |1 S. {5 j: q% L( X$ t- C
/ k9 e2 s( D* k+ L- l! O
选择新建全局代码片段文件。0 t& M- ] U/ i( @ t. h
& v) D3 j, Z7 G/ B 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
" B& E+ i ?* i# @/ N
) ]& ^- n- e5 i& A+ ~ command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
8 ~, @. o+ E- Z8 r5 [
$ }6 a, `4 _$ u 生成的代码片段如下:/ n4 K Q' S5 U* X* B l0 A. h- a
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;五、打包 ! j( A. J. n/ a
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。" [' x0 Q/ E L
六、发布
8 l7 H9 H; J: ^9 B G. Y5 p 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
) G+ j+ J- |5 j. D
3 {; m0 {8 N! r- h
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~5 I) H) { @) S; O
# t7 P- O, |4 }* @. g: J [" ~ 七、结语
~) U4 s2 x' |2 Z vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。