一、前言
4 ~1 \) ]* }3 L6 ` 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
7 Y+ r! @2 s0 g二、环境准备7 C! k7 I. r' i2 p
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
. \# @0 F+ y( h/ S7 `" U4 F$ J 三、开发者账号申请' I, O7 z5 b) ^3 o2 \' X- `
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。' }$ L) x( g9 }& Q1 S9 `' u
1.注册并登录 Azure DevOps。
! T+ V( G/ {" W; T2.选择或者创建一个组织(new organization)。
1 E3 I; `4 I- `# b3.在该组织下创建一个项目(new project)。
+ D9 ?6 U Z& r8 e" D 以上三步都是为了获取开发者(publisher)的token,获取token如下图:9 d( W" M8 b3 B/ Q' Y0 A
7 z! U. s3 L; C7 J
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。) P t; l7 b% T& @1 ^( l
+ o7 j- Q6 J0 X) [5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
% A' q9 b* s* X7 V: d三、项目搭建
( G+ P: b) u' D5 O( i* e, v1、项目初始化) ~9 I: }5 F6 w# |5 u
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
1 w9 s8 p8 C {! [, O8 G6 }4 Z
9 Z; j2 ?" S! u! J( P H9 k( _. N2、项目改造# i0 x7 p' c, t& O
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
" l- u9 F- ]' |4 {8 v( n8 Q1.将package.json改造成以下模样:8 Q2 ^8 _- Y* F; t* C
{
"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包会失败。
0 v+ I8 a/ d5 N5 J! K" L( k3、编码
" H% l2 W4 p6 {' J$ z2 | 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:7 Z& {4 i2 P3 v7 J. d. A" l
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
: o& l; Z/ a7 }% J( Y9 U四、调试1 A7 t2 N0 l0 L# p+ Q
单纯的开发代码片段的话测试和调试都非常简单:
9 e3 S3 f0 g* Z( O k- 首先先自定义全局的code snippet。
. e* }/ c0 e& B/ n, \5 `# b: Y) V( G
& p h I8 n0 P% I- 选择新建全局代码片段文件。
5 ]! _1 t' w) N
: C, H' q% m0 ^% U) h- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
/ Z) Q# ]' g+ O4 M M' i
+ @! a Z! h+ v
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
4 @* x0 o7 A5 l6 ?3 T
7 R! R/ g+ I; p3 l 生成的代码片段如下:
0 |% N1 u/ d# S; G" G" uimport 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; 五、打包
6 x# x, d7 _! z& g M2 Z) x 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。& D3 m4 C" c9 R" ? |
六、发布
/ @9 I. G Q7 j# J" |+ ^% E3 a$ C 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
: K1 ~. Y; [! u; G' `) b3 h2 Q
( L" A/ ]! e: ^4 [( Z8 d0 K, n! J1 H% [% e
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
/ o& Q% D* E q: \+ E, y$ V
2 ^0 a' Y" X7 j3 ?8 i5 L七、结语. t* y# U# w' w3 g; j
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |