一、前言) Z' T% Z7 c+ V2 |
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。2 o2 d0 p R; {1 r+ x5 E
二、环境准备$ `4 o" O% |4 H& e
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
% @2 B( p2 w, x; S* o/ d* P 三、开发者账号申请6 r- i+ ~1 [) O% p3 z; ^$ a l
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
% O9 F' ~0 ]' @6 c# P3 k+ G8 F6 e1.注册并登录 Azure DevOps。" D3 w9 l5 ~7 W- x
2.选择或者创建一个组织(new organization)。
: x, m& Q; w% u+ S) v3.在该组织下创建一个项目(new project)。' h9 e i) z7 K5 O- i/ G- U8 q
以上三步都是为了获取开发者(publisher)的token,获取token如下图:7 f3 ^& Y# ~7 ?# ?* v
+ Y: V- w4 Y2 ~& m; {
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。9 S3 Y" s6 \( Y/ C, q: q' Y0 Z
$ I( W2 f" G/ \! R: h# R5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
% ~; L7 U7 {8 L) Y/ l7 ]# E9 ]三、项目搭建- h, L7 g+ [ H5 x7 _
1、项目初始化
& B+ R& v; R9 y' T3 `7 g9 m- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
1 k& \) a. ^0 `4 b! l. r
. _* C4 L7 C) X& C4 [( Z1 e2 i; ]
2、项目改造# K) }/ W7 ~( y; U; i) `) V. {
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
; h% w! z2 j2 A6 b4 X; `1.将package.json改造成以下模样:
! E8 [# s# Y; _( {{
"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包会失败。
5 d6 n1 a5 p; _) f3、编码+ P: m4 y* n* w2 P2 G. C1 X) s$ ?
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
7 {1 m7 I5 |5 Q* T- x" A{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
4 e% b2 g8 L& m% C6 f四、调试# d" W0 g0 q8 w3 U: G
单纯的开发代码片段的话测试和调试都非常简单:7 S ` m" y( x: G* r- y5 `
- 首先先自定义全局的code snippet。1 W7 F! v$ U6 r
& }/ U$ @) f, H3 F! R* h+ t! c% f ^- 选择新建全局代码片段文件。; K( W" @7 K9 o1 \7 Z/ {/ P6 Y5 n
# I/ j$ ?* K$ Q( M* p- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
# E! G0 g3 D. c) f9 { j
) v+ f. ?. a' o' K4 v
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。1 B, A! l [5 {+ `" L/ h/ g4 m7 R! E
2 m* j# i5 h. q8 R8 E0 ~" _3 K" a
生成的代码片段如下:
7 I! c7 L4 @& F0 b, `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; 五、打包
# \' f& c: I% k. M 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
, ^ v! |/ c7 G i+ o* d0 K- {六、发布
4 j! Y& S0 J3 `3 k 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!' e6 b+ y/ U0 n* s* Z( V5 Z
7 _7 ?# D8 j Z7 L% i( g
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
9 E# ~" j3 r" a/ H" F0 P3 ]
$ I0 J6 {! K( \5 p1 K( S7 `2 J+ f
七、结语( H6 N3 T7 l4 |" }8 ?' W
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |