一、前言
) X( b/ j) q( U1 u8 ]6 N 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
8 N1 c# ?) k7 T二、环境准备
3 K( ]& _9 J) `3 @, u- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
5 w& K4 ^# k7 T" ?' q: ^" A 三、开发者账号申请5 g- U2 T6 F( h& `! o3 T
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。+ f& J4 @9 @/ j7 I+ ^. B
1.注册并登录 Azure DevOps。
6 `, e/ O5 k; S0 @2.选择或者创建一个组织(new organization)。
- m# Z; S' D8 t, A& R3.在该组织下创建一个项目(new project)。+ [# s5 B0 R/ y. i
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
; E3 i& s8 w) z7 i9 T
5 K; x7 ~! }0 B: O2 I4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
# l6 Z/ Z6 `4 P6 |( Y+ p
% e( G6 F$ q( ^0 _6 @5 K# K
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。) k* P) M1 m# d& B2 _& O, g
三、项目搭建4 E+ ~7 W% B' n- Z; z( d
1、项目初始化0 H: H" r, @. }4 b: |# @3 G3 p
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。# ^+ F4 W' L3 x# ]+ n# F
3 y# ~. M: }" v
2、项目改造
; x) a5 a. b* J3 t" [ C7 c# N( x 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:& i. i. a2 j: B" X$ x' O
1.将package.json改造成以下模样:, J: I* }0 G: w5 |
{
"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包会失败。' L) x: {# p8 j; |
3、编码0 p7 Y: m; W; d. [ r) r' F |
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
5 w2 h8 H6 D$ j7 K# 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。7 J3 F/ R: K6 W" x: P4 Z+ O9 _4 d- S
四、调试
6 m& I P5 d3 H. l& O m3 S; S) p" z 单纯的开发代码片段的话测试和调试都非常简单:9 `$ e2 N& C* f% y5 T
- 首先先自定义全局的code snippet。: H" o, L$ F- @/ ~
! I7 G3 |4 X8 G0 _! P j8 n3 G( @- 选择新建全局代码片段文件。* L9 G$ L* t+ b, S' X) `% U% r$ |5 P
' t& K; o9 Y* Y: p
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
' m& \& M" u) B1 C" [6 \* w: T7 g
7 F$ m# y6 F1 H
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
+ A0 [. \! X' Z% N; g P
J+ b j" {3 ?) P9 O4 o' l% w
生成的代码片段如下:3 f! o7 F& e* ~
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; 五、打包
E5 p0 X0 n2 F6 a' f8 S 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。! x) u6 c# S# o g6 r
六、发布
K z+ h+ t; s0 f; R/ z) F& o- G 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
5 k7 |/ L! a5 P J
( x V, c, U5 F2 Q3 W 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~! v5 J; k# U2 g
. a. W8 B$ r( V$ x七、结语' F7 v- D: D5 Q
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |