一、前言
4 Y) v: ^9 d% ~- g+ t 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
P1 \: U7 o* z: B/ t8 j- w二、环境准备
! u0 ~- K+ v" w& P) @3 W- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g4 c. y" J* d S1 r
三、开发者账号申请, W& W- W5 {$ E( s! x. z
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。. I! ?9 ~3 ^& A0 t6 R8 T
1.注册并登录 Azure DevOps。
0 H E0 S& G/ e/ s! |. N3 c2.选择或者创建一个组织(new organization)。
9 A( E% i" G. @3.在该组织下创建一个项目(new project)。
" k- Z. W- A# y8 r% t 以上三步都是为了获取开发者(publisher)的token,获取token如下图: y4 H2 e' v' ?: o* ~
5 S- }" N* u9 G' m2 Y4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。, B/ Q8 t* U: ~3 Q
+ p. u9 \, M& h* d
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
9 y! x- F9 f% Z3 s三、项目搭建1 p% Z2 n: t7 D
1、项目初始化) _! p3 _; z4 Z& o- x
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
~2 u4 C. l, f) F
' r; a/ [# c2 Q6 u6 D, O
2、项目改造
3 F: z, v' Z" Q. J, \' \ 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
+ e. k5 ]1 k3 ]$ ?# h1.将package.json改造成以下模样: J f! J, I: G% x3 k7 X0 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包会失败。
4 `% d2 X( L( Q2 B! U! V- M {3、编码
6 R) v+ C1 ?# R4 @# a 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:( l9 j! F% E l/ q
{
"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 J0 P1 J& M! o1 l! a+ M' k# q2 \四、调试
% R& r9 a. d" S! K; `7 F; k 单纯的开发代码片段的话测试和调试都非常简单:
4 G y" S1 s) P4 o& j. [; e4 r! @- 首先先自定义全局的code snippet。6 M ?$ h4 ~' f
" c7 m" V9 U. A, f! Y3 @6 W
- 选择新建全局代码片段文件。
4 b, I& A, O# ?$ d" Y& @4 C7 D
" W$ Q6 s$ D1 P3 v- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。) f U. J& p% F4 o( M3 o/ \; N
E" E. G# ]# g% V; ^, t( W* o9 K: V- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
' t9 P2 L; n. Y
: P- t/ L M( w8 y4 C 生成的代码片段如下:, U8 _$ p: b t8 }2 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; 五、打包
% V2 D! Y- a$ B P `, { 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。0 U- a7 `4 K2 f4 f. O3 N0 f2 `0 j
六、发布
# U9 m1 A& [3 e4 e 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!! |* O+ P! c# [" \- n4 v
1 L* {8 W9 B$ M1 s9 H7 L
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~; h) L2 A' V; a: c- V- x1 t5 D4 V
/ |; P1 {6 v y! E: P
七、结语 W. G. ^+ E, `9 E0 w
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |