一、前言
1 g9 U% y" H7 F) l( Q4 U 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
" H9 @% V4 ?% s! E" e. Q5 W/ J9 o5 H二、环境准备
! V- r5 j, f3 m$ Y6 i- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
5 r; } I- S, Y8 v* r) @ 三、开发者账号申请
5 c2 D$ E) q2 e5 a( a1 b 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
* Q J! K( P) v) O; h6 H, l1.注册并登录 Azure DevOps。
" ~) {# F U5 W0 a2.选择或者创建一个组织(new organization)。
1 E& f$ E+ S0 I; n* l3.在该组织下创建一个项目(new project)。0 z! E9 W* h N2 m
以上三步都是为了获取开发者(publisher)的token,获取token如下图:; a1 j5 |3 [6 a8 S( K2 Z
; U! ?- T' h: g: H! u2 e
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
/ b c8 ]$ L7 e& b3 O
( V# ]; }$ D& u
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。0 }' V* T6 M2 B4 `, R5 ]6 d$ B& {8 G
三、项目搭建5 \, ^2 c/ J/ s, u9 W H- [- ^
1、项目初始化5 C. x, F4 G. b3 d
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
3 W+ i7 b" f7 l: l% r
. k- U" q1 L, C6 R/ ~9 Z) ?4 t
2、项目改造
, ]9 F( j9 }$ n& _ 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
: ?) F# q4 g$ b6 r {4 [ w1.将package.json改造成以下模样:
: _6 L, |3 E' h" w' 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 J+ Y# [: {, O `3、编码, }& h" R, N2 g- s
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
1 Z4 @7 l5 t' j( [& 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
1 l( y. k/ S3 f四、调试
2 ~- g; }/ s6 f9 `$ D7 t) z2 H 单纯的开发代码片段的话测试和调试都非常简单:+ |: p4 A* ? S7 k
- 首先先自定义全局的code snippet。6 G" V G5 `- `& R, @. F& w" h
: K/ Q& M: G- q& j9 z) s& z& d3 {5 a
- 选择新建全局代码片段文件。
m7 E! u+ |' j4 h
# d7 Z o! t/ W' Y- O2 V S- f
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
# a z M5 U* ]
9 L! g; L# d" f* n* {4 F
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。) Y4 E0 X( g4 y* z- u! m: |, }8 e
I1 Y( U3 i' ^ 生成的代码片段如下:" K! m8 W5 ~- U1 B' T- V O
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; 五、打包
+ u& M/ n( e3 x9 { N 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。6 s5 F; U, H2 [
六、发布% @: \% B+ R; l
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!, X8 o* |! `/ S9 Q7 r; E- v8 T0 r
5 J0 M8 v5 W. |* i6 J- H0 ^' K
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~2 _3 z/ M# F; F7 ^- ^
( Q! q+ D: n% p9 f7 x6 f七、结语
& U3 Q9 @& X; w! H3 W vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |