一、前言 - I) _+ _! W" r( _
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
" V3 B7 y5 A! K9 p' v* G \6 q* J% e 二、环境准备
# \5 b& b: `7 C# ]7 q: z node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g' g% G, b+ c) k, u# W% W: y
三、开发者账号申请 , o0 B) o5 E/ J' o J M
点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。" D4 D0 A0 k% G0 ? [; o+ s
1.注册并登录 Azure DevOps 。
" D7 v( g% C9 E0 Q 2.选择或者创建一个组织(new organization)。
& [: `+ ^$ C6 T3 C6 `" H 3.在该组织下创建一个项目(new project)。7 W5 u3 s0 O( @
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
, d% j& k* X% h% X8 o
7 b- ?" D( Q+ [: [ 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。; u- H: {8 M4 X- Q
- ^; m3 F( s! ~0 @8 C( E$ N 5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。( l; Y9 o. L6 y
三、项目搭建
6 Y7 y2 @$ w- i" ] 1、项目初始化
3 A- v& z& M6 b: r 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。' b! ?6 n& a- ~2 k
3 C5 J6 ^8 r- L. d" \$ J1 c# d, S i
2、项目改造
/ X8 R2 o3 w Z# p5 u8 R/ |- z6 c 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:8 U5 l6 f. Y! D+ k' W
1.将package.json改造成以下模样:( O0 s, A! y- a% 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包会失败。
1 b0 `2 q. n" `; Y 3、编码 5 i7 L c/ z8 V+ E
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:; S! `/ P7 q- A+ K& [, J0 ?
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。/ l' @ R& x/ h9 d" U1 d
四、调试
% z' {$ U# {: N3 c: l 单纯的开发代码片段的话测试和调试都非常简单:2 H7 Z! n' D; C+ s! o1 ~
首先先自定义全局的code snippet。4 H2 U! y* ^: j3 z# D
6 v0 H* w a! J9 N 选择新建全局代码片段文件。6 J8 {- j; G, a$ ]2 J! F: {) a
) A* T: F; X* k* c3 L/ c
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
8 ~ l, ?: c$ J+ Z( B4 _. H* M
0 w3 ~) F$ s) R2 ~- M2 y command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
# G# o5 `: G% Z3 ?! _0 Q( u
/ h6 X) `, O- z$ k9 f. ~
生成的代码片段如下:# Y3 S1 r# i/ C" N0 M
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;五、打包 6 W0 O9 _+ `' n# x
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
) B$ H. x: U+ F4 q# p# N 六、发布 ! R, _1 M9 ~( W" r3 r
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
% u% v& R: m0 D% {
& Q' X0 E- L4 y8 E/ q0 g
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
( ]; B1 s0 I4 Q0 q
. R5 ^& Y4 m# J- o1 m* G! v+ ~3 w
七、结语 $ \6 o! \8 Y+ |; v7 k/ b. t# S
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。