一、前言
1 W# ]0 g* X5 R, O) p( x1 ?. o5 L 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。9 O9 ]% ]8 Q ? L0 C* @* I( ?
二、环境准备 * G) B8 s) Y9 Z& m ~
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
0 Y9 w* H$ N1 Z* ^5 k$ W- ~/ N" r% D 三、开发者账号申请 2 P1 A1 T) v9 E( g
点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。9 E8 n) c& W/ V$ R, I" J
1.注册并登录 Azure DevOps 。
v( y( g' C8 T 2.选择或者创建一个组织(new organization)。4 Q% {4 q8 r# @6 @
3.在该组织下创建一个项目(new project)。2 [7 U. [& X0 \6 Z; g" p
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
9 `4 f8 E% Q& I; p8 O
! f" {, Q, O9 V+ U2 r1 X 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
$ ~1 `* r6 _% A
: | V. n9 O5 a3 n
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。$ q. f8 O' R- L2 F7 u
三、项目搭建 O; X3 ^! E: R! a
1、项目初始化 $ [; L2 p* q& j; c
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
8 e" W; w+ ]$ D7 }& t: F
$ X0 h3 k/ H2 }
2、项目改造
9 S; C( B- z7 @( a 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:- O; f$ m/ G) N- n/ `4 k# j+ b
1.将package.json改造成以下模样:$ M1 p$ L, u& F$ m' ?+ G3 s
{
"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 U7 E0 V4 M' u4 ^. h* m0 l 3、编码
+ J1 g+ ?' O/ v4 Z/ R5 {* z, } 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
9 B( ~6 a* d; c. t/ g/ } {
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。5 H4 i. J8 A) z; m+ t( Z
四、调试 6 a8 s8 Q, ?: {
单纯的开发代码片段的话测试和调试都非常简单:8 E J, J2 ]9 V: Q8 l4 R
首先先自定义全局的code snippet。
d4 u. r$ |( k& `* ^
/ U1 F1 m" P* z @) C- r. L 选择新建全局代码片段文件。& x# P/ @3 [) T; @ @2 ]/ B
1 ]# u2 v- y8 U, m4 C
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
7 F. _& b& D6 w7 v
) Y- d5 }' K& I2 y/ K" z command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。: f0 X+ Z$ \3 s6 |
7 h# v4 o5 T: ]! a 生成的代码片段如下:4 a; `9 `, W8 t
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;五、打包 , ~! k$ J% X& y( ~# n. h
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: \$ Y- W* d- Y2 b
六、发布 % s8 h+ G2 a+ R3 E' d
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
- W) ^. W& L, Z
3 k+ o' |6 ~7 n% q3 Q$ x/ E 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
2 R9 s/ \; R. ^
, m& F; K" @) G# J2 a
七、结语 # i! p: {# b) E0 [, c6 T8 v
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。