一、前言
" I$ H6 s: L9 j. V! G1 X/ X9 }; c 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
/ a q. n" C: d! ~" p; W二、环境准备( A% l2 B" I0 D& b+ t
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g' p1 Z% E6 r1 g; V
三、开发者账号申请
5 G, s5 e3 P+ x- ?6 c% k& H' _ 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。+ I( |) G+ j! ~4 ~( P* g5 ^
1.注册并登录 Azure DevOps。! p8 N1 c8 G/ o& ^" C; s: \
2.选择或者创建一个组织(new organization)。. ?( H, [4 n' f
3.在该组织下创建一个项目(new project)。/ u# \, K0 Z" ~
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
$ l# M) r+ z( v6 `8 C" F
0 q. G" V- `) a4 Q( j0 [* i7 j
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
, Q5 T* }1 Y7 R
9 [9 s# A! a; U
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
9 K! T+ b+ p/ @8 u w& G2 C. s三、项目搭建
* X- g& ?6 j& ?1 v9 Z7 p1、项目初始化
' d' o+ U2 d& o9 H1 l+ I9 H; B3 u- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
0 c3 P$ q* j/ J1 p7 g: D" {
. b: `, O7 Z2 r7 U
2、项目改造
! V7 P7 i" u t* b4 p 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
6 |) e5 x1 d, S3 z+ l) w0 n1 e% K; b1.将package.json改造成以下模样:$ s. N% T8 N+ 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包会失败。5 D5 j$ _3 {/ {7 M
3、编码+ N2 ? o5 b/ g% q
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
* D$ `' `! ?, h( d. i 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。- g [" `! ^, O6 p& S2 _8 M
四、调试
" T4 H4 y6 p! q( U3 S& c5 F0 i 单纯的开发代码片段的话测试和调试都非常简单:3 y& `* A# }0 X( D
- 首先先自定义全局的code snippet。6 S6 X: D7 Z7 r7 Q0 w; ?
% m8 h/ b$ Y F* Q. a- 选择新建全局代码片段文件。1 }& [3 `9 O+ z* X
, H9 A! t2 ~' g
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
0 R/ ?) ~& Q9 J, d. Y5 d3 _- e
9 ?% S5 D, s! k h1 ~9 j2 s9 K3 y- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。/ k) E8 A' J8 G& S+ ?4 E7 O: E
+ B9 B# ~/ y4 L. I2 G# B 生成的代码片段如下:
6 M2 t0 w+ S- l: l: limport 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; 五、打包/ y; l% C- a4 P& h4 R
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。* j7 V# S" ~& |% r, ?* ?, X
六、发布) _1 F5 u V' D7 k/ w+ {
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!; ^; C* P( A: P7 D
) o$ B( @3 m$ e% u" s4 N( N3 G 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
8 x3 V" Z+ [# G5 j4 I1 F# h9 \9 m
- w, D: n' {# m: r" J0 I# G. y: y& e( l
七、结语
, o; c Q' b. H) [ C1 K vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |