一、前言
6 H" m) V: a% {, j/ }7 @ 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。- a" K, j4 Z2 p1 P
二、环境准备 " }5 S# x0 j4 z
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g, x$ g5 r [; `- g
三、开发者账号申请
/ ~/ e* M: }' H5 k$ v$ n 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。! c q) `% {8 N4 x8 ~/ I- _ e1 B& B0 k
1.注册并登录 Azure DevOps 。0 c' g; V3 s( J* p5 `4 g* h/ I
2.选择或者创建一个组织(new organization)。0 L' ?) F- ]. g% H) L8 A
3.在该组织下创建一个项目(new project)。# F) u* q/ G2 F* t! L/ W; z" b
以上三步都是为了获取开发者(publisher)的token,获取token如下图:4 S8 w9 |- Z* r, r* l' j
: @! o/ ~& d3 H7 D" t
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。! r8 E( @" \* z' F e" {# U
" n1 b- A% j6 e
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。5 r5 r2 z! P5 E2 a Q2 ]4 V: A1 a/ W
三、项目搭建
' v) ^4 {2 w# _& H% m- N 1、项目初始化
0 x2 a `( ^' N! T9 O7 o: _& B 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。3 s* C' X4 s: S+ ~, X5 J
5 ?8 x) I( G, K8 z' U* ] 2、项目改造
2 J4 r. j! V" K$ `/ z1 y& F1 G 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
+ \& r4 v, [6 h7 P3 U! ?; A$ O 1.将package.json改造成以下模样:/ S2 @) o% j, Z7 D9 n" L7 ]
{
"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 N ^0 I4 \* B1 V( `) D, |3 `
3、编码
: S( m0 v# Z; ~( y5 o& J 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:+ U! y! d) e& L$ N2 _, n1 ^, Z
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。& m& k6 k) [0 J. o3 A
四、调试 ) @8 w0 R2 N0 {( w
单纯的开发代码片段的话测试和调试都非常简单:- [3 w& C& L h3 m7 K
首先先自定义全局的code snippet。, V0 Z1 f; `4 K* K# Z# k! Y
, A' Y* o z- S
选择新建全局代码片段文件。
; k+ m5 C5 v1 U# H
2 w, [2 X: J0 h 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
; |1 P2 M* W. q; j3 W& j4 S2 W& g
2 l; C6 Q4 g0 o7 u+ Q command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
* P/ a Q& k6 g; N2 J
6 w/ L8 ]: y) Y
生成的代码片段如下:; g. j6 o" T7 r( ]# v
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;五、打包 : u7 y: ]: t6 e7 a+ X- c0 S- b" o
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
8 L+ f/ a F7 m 六、发布
+ y" n; [ W7 N 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
' y+ `1 b+ [0 f) y# c/ h
7 z5 S* _/ A; K
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~0 |6 X6 M- m& b# |9 L1 [ [/ e
+ c6 n s3 d! V 七、结语
6 A$ e6 d; }6 h vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。