一、前言
! A {4 T5 M V. a' q5 U 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
$ _+ L1 M+ P( j3 H$ B( n0 M# X二、环境准备# \% u- \5 }; o6 U% S9 J
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
- H) W. \; H2 D# ]& P1 k. Z 三、开发者账号申请
0 G# H/ H$ |5 z& |$ x 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。! a# }# @0 ^% P: U, P% Z
1.注册并登录 Azure DevOps。
! O, R( |) J2 O; f; m, ]7 O2.选择或者创建一个组织(new organization)。
7 i; D) ^* X7 i* f3.在该组织下创建一个项目(new project)。' {* j( l* W; D2 e& n: D3 b0 k! b3 C
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
( n$ F0 n% d' q3 V! t/ L
5 Q4 y( b y ]) C* w
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。$ @0 P2 ?/ k; c. `5 J+ j
- Y1 w6 }6 \1 J v% I' Q5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。& z& U0 j$ I3 }$ J
三、项目搭建3 L8 ?( a% Z3 @& }; z1 t
1、项目初始化
# @: \4 a9 X) G! X, X& Z) d& A& m- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
- N4 S# z! e: {; i, F+ d4 S
+ W4 v6 z% ?6 R" K+ Y' K
2、项目改造
" q' A- E- N7 L; `) f% A! f+ h } 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
* U; u9 l& w% y7 [, K9 ?4 P1.将package.json改造成以下模样:1 r% E% h9 W* V5 F m6 C0 b
{
"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包会失败。
- X: a$ ?5 Y3 |% O, }3、编码 y6 o' P. x! @/ r& T- ~
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
* X' s5 v# l1 V: {{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
3 b/ ~: Q, K4 u7 R' O2 L z四、调试
. |2 y; h) L& }/ ?1 p7 a 单纯的开发代码片段的话测试和调试都非常简单:2 Z9 U, ~: S& |! f* n! @
- 首先先自定义全局的code snippet。( a2 A5 G, a: O5 A0 f$ M2 t2 u
6 c7 T6 `4 C$ `% P& K- `- 选择新建全局代码片段文件。
. q' _4 E0 L; M2 I7 B
' y6 t( e9 q a, p/ e, o- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。4 P' a$ a. f) a( t
S7 P: f+ w" S5 b+ y Y& n- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。, O' R7 u2 H; H R) H" e+ R
' a4 s8 `7 k/ C+ C; B! p% p4 L
生成的代码片段如下:
2 t9 v/ U% L6 a0 ^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: z' v* |- C9 d3 c, T4 U7 w G
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
' L5 Z" w, n/ |- a* a六、发布 |& h5 p3 |2 _- O1 m
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!, x `7 c" Q. X+ }
+ e5 f+ f$ N) U3 L6 [8 ~
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~2 B! u! [0 m& e2 e
# w! x" H9 ^0 C& g* d0 g. W7 G& ]. A' d
七、结语2 \5 g5 H/ e/ i8 _* A. R
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |