一、前言
3 P0 U- F4 t1 w5 F! w. w) l" R 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
# B' F5 ?- U1 b, W二、环境准备2 g) _' ~$ O% h7 E0 ]9 s1 I2 R
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g1 ?' S- h& e2 k8 o$ H* @8 d# D5 T
三、开发者账号申请
7 K4 |& Z3 d% |( x* l* W$ ~8 S. x 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。) _0 `$ W, O/ i9 Q6 {4 v
1.注册并登录 Azure DevOps。
B, E2 H7 S! L- M1 }2.选择或者创建一个组织(new organization)。+ ^/ Y _$ F. m
3.在该组织下创建一个项目(new project)。$ Z" O& {& B+ O5 O! h
以上三步都是为了获取开发者(publisher)的token,获取token如下图:( E/ a: p. O" H) {
6 X' E- W1 s3 Q7 ?: {2 i4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。8 m* b* \( ]/ m
) ` M% n% q6 V5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
y: g1 u* n9 \. v三、项目搭建. U' i' A8 \; P N6 }+ g0 O
1、项目初始化
1 s+ e/ e1 o' y- k6 V5 X/ I y- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
# j# j5 q: M5 o# u8 \) v7 `
4 L! w8 p7 ^4 j" F' Z0 y; j2、项目改造
& O& d& R! |0 l/ n; \9 C# C G 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
$ ^0 Q- m% g3 }0 c( u6 `& k) @1.将package.json改造成以下模样:* ~ D2 \1 n9 l4 w; Z$ ^. v' D
{
"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 U: ?* z$ o$ Y$ w; |& `8 \) I
3、编码
% R3 G/ [6 b% t- q1 I1 g3 ~ 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
+ c2 v: f3 }) i# R5 {1 ^3 k{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
2 n! j# c* ^3 E! I* w1 h四、调试/ Z2 o5 t# O0 _8 z) T! E
单纯的开发代码片段的话测试和调试都非常简单:( q5 x+ Z" S. V! \. \$ X4 m
- 首先先自定义全局的code snippet。! Q, l; M2 @9 n; O
7 D4 T7 U6 o$ n" H) O
- 选择新建全局代码片段文件。
% @7 M2 V+ N$ T7 m, _
6 w4 c9 P/ i/ Y+ @
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。6 m4 b9 W& \4 K( Q
7 y0 N2 s4 r; v9 ~2 ^3 m- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
+ v6 ]; _8 V- t" C) S/ j( G
2 B* ?: R0 G% i 生成的代码片段如下:
^8 V; c1 u- Y6 p% s3 m- S; Himport 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; 五、打包
( q8 n& P/ j/ o9 O F4 k 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
1 \4 H8 x! t: F/ b1 h/ k0 d9 l+ b/ h六、发布
2 ?5 b) [$ {. }$ ?+ V' S 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
5 K v5 K# {: U+ Q
) E5 W( v1 [: r) Q) J
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
2 H% ^' W( s4 q, C# V1 E
7 g; |& V3 j2 z1 N; x# Q9 Q七、结语$ |: v7 t- k) D( U' |- c+ }
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |