一、前言
1 C6 i6 `' q4 E$ L U4 {, O 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
: W* K# A% r' `) @* f8 E二、环境准备) r: s, {* }0 d
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g, ^; L3 N H- i8 D
三、开发者账号申请6 J- A! _, P( P
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。/ d% B* ~/ R: Z
1.注册并登录 Azure DevOps。. A: [0 Y1 N6 J$ s$ j( q% w& U$ N) x
2.选择或者创建一个组织(new organization)。0 j7 V: ~; N+ c- z& N( c- ]
3.在该组织下创建一个项目(new project)。
: L6 ?2 e/ O: {$ B7 n 以上三步都是为了获取开发者(publisher)的token,获取token如下图:6 C% k! ^. q/ x8 W/ x' X6 u3 b
% I# f4 E: v6 o8 U3 w
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
9 Q/ u5 g7 {3 h* ]7 \
4 @+ D9 u% \. v2 w6 Y# D! e5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
3 v; ]' ^$ X% B! U& w三、项目搭建
' V9 y0 ~, m6 W! b1、项目初始化2 ?# i; b$ \5 ~' D5 h3 w7 v! n
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
( U( y, m# m: w' S) H/ I4 N
u% q1 d5 Q1 e" @. W; B2、项目改造, `- D1 W( _% P" z8 v
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:) X0 @0 i1 F; G& _, U* Y& w
1.将package.json改造成以下模样:
* h* {7 F6 ]+ F{
"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 r$ R+ E/ t9 \/ P5 q: m8 y% ~3、编码- L& H: a8 T7 C0 a( F y1 r
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入: q& C! Q$ b. E' z6 N* |0 K" c
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
' W# R k3 m& T5 u: x6 K: j& \四、调试' L* h; x7 M* k
单纯的开发代码片段的话测试和调试都非常简单:
* [( m9 Z. O& w- 首先先自定义全局的code snippet。
m! ~+ r% O) P9 u
5 K& @( d+ k T3 r8 F, G+ A0 T
- 选择新建全局代码片段文件。- V' _3 T+ ]5 T7 U! X8 L1 f" y
6 y5 d) ]" m" r
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
* X, V9 n& B& o8 S
# U. C2 m/ o" G% F) @- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。0 r8 W- ?; i% H- U" S
: j# n* a' P" M$ n O% j 生成的代码片段如下:: ~, P, j! T$ L' H0 L) @, n& ~
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; 五、打包8 [7 j( I9 |# u! o- r* W. c
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
& g! z1 J! z6 h y. ]8 B# B5 w六、发布
- i& o0 i2 v# \" _( m' ?3 g 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
) j3 L4 k( F8 J% \" Z, n% I
( {( o/ D" q& y9 i. C1 C
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
0 }3 Y" `! `' y3 U) w& b
; s3 Z; A! }' Q
七、结语
! `, H& y; v# I7 O: Y2 f/ v6 p5 y3 v vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |