一、前言
' @4 t O, Z7 f) C$ y 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。, |* X- M0 A/ C6 H9 J
二、环境准备1 k- n2 C+ K3 `5 J5 h, Y
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g: x" z! c. r+ {* y! n
三、开发者账号申请0 c# n1 I3 w' ]
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。9 R9 w" b$ H; I8 P. }
1.注册并登录 Azure DevOps。
7 ~. b/ ]5 d! V/ C2.选择或者创建一个组织(new organization)。: b. H7 u5 m3 R @' G/ p& |
3.在该组织下创建一个项目(new project)。! c' \& V; X& ]1 e* w
以上三步都是为了获取开发者(publisher)的token,获取token如下图:! q4 m$ z# b K" Z7 ?4 N
# D* |& v0 f8 ]/ L2 V, }4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。* z9 m1 G& n$ \0 l1 \9 }
3 N# f1 M2 Z- \/ e0 P5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。- t& b- o& q+ d1 t. M' a9 D* {1 m
三、项目搭建/ s3 ^5 w! q$ t* C) ?
1、项目初始化8 @2 E# F! q6 a% B8 N4 M9 F, l2 m; \+ u
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
5 V r4 m0 j. t: s
1 {8 ~) c4 i8 y2、项目改造5 ]/ \! D: M+ \' g+ {" F
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:0 `" ^+ d. _: u4 w
1.将package.json改造成以下模样:, @+ v2 p+ z: r- f; x7 V; ?
{
"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包会失败。
* J1 W9 f" w$ h- G7 w) B4 {1 {3、编码
6 V$ {# D. e% w 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
. ]! H( V' z" C3 f8 w4 H{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
* @" h+ _/ k( }. U1 [四、调试
" T/ Q2 T1 S3 p5 l 单纯的开发代码片段的话测试和调试都非常简单:
" i- q- L7 A! H0 \* O" ~- 首先先自定义全局的code snippet。+ {5 i' l% e$ w6 B) A$ q
) T8 _9 l6 ^: O% p. Z
- 选择新建全局代码片段文件。
5 b7 ]9 N9 E+ w5 G( H* Y. y9 A
6 g3 r0 ?( f6 |# L
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。 V$ ^; Y9 C$ i3 Y8 r: t1 \4 ]# l
# q7 }! _) J. M8 l) j) r0 O0 s- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
1 P `, r0 N1 Q; C* g
6 k; e* ~3 T! S# {% W 生成的代码片段如下:; y! H+ A1 o; o+ B( [1 D
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; 五、打包4 W3 E3 M( Z3 H( B5 ~5 |
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。 a3 K& ?0 ]0 [9 v+ O
六、发布# r d y$ H+ K3 k6 F" Z
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
% h: u& F# o1 B! u7 j
. O7 H8 x$ s9 H5 |5 \ 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
( O$ P' @/ l& S9 x
# V' c Y4 d& V七、结语( ]* x0 }6 S: ]+ {/ E2 b/ D$ ]
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |