一、前言 h" t& u0 A' B* P" M& \* ]
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。7 F( V8 i7 U. Z/ K- k
二、环境准备
% W5 D- |0 r5 Q% H- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g# H( @" D3 Z/ y& J! Z: J
三、开发者账号申请
- y8 h9 ?8 D2 p" s6 Y 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。2 ^) c5 O R) p! J/ G8 Z" p
1.注册并登录 Azure DevOps。6 C" I/ n4 n1 @6 z) v( M
2.选择或者创建一个组织(new organization)。" |4 w+ F, X5 i! a& @0 q" k5 H
3.在该组织下创建一个项目(new project)。
- z1 b8 W9 ~: k. h( X 以上三步都是为了获取开发者(publisher)的token,获取token如下图:: R. ^- O6 ?4 {
1 M6 p2 W0 l: y4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
" r( y% O5 n/ E. c$ T
) X* `4 i( j' P& l8 r
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
/ y; a( r; M, `# y+ t7 A$ s {三、项目搭建
2 [' W0 _& W9 [1、项目初始化
1 ^, }! V4 O/ }1 j' N- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。9 ^- h/ }) Y5 o
' r: n( n" l" t# T2、项目改造1 c1 V" G! k# V% e6 j5 Z
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:0 Z- e& m0 V2 _0 R; q. s' h
1.将package.json改造成以下模样:; Z4 |; f$ t% N" I' 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包会失败。/ N$ f7 u, r `9 q
3、编码
9 f; h: j) z# K' S; f# z& J 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
& A" H7 B0 b p$ a/ w{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。5 U6 B3 ?$ y6 u! \: M
四、调试
4 x: @; P# K9 b( f% ~ 单纯的开发代码片段的话测试和调试都非常简单:
1 ]/ f* {: k2 I+ o* a- 首先先自定义全局的code snippet。& n: {$ F8 S Q! Z
# T+ \( o, [: w* ^: n
- 选择新建全局代码片段文件。
, Q N, Z6 r* U" w/ J# j- h, [
; H3 Q6 ]& t0 h7 q/ D
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
3 }+ G% W5 e" S2 z
& m7 A; t4 ^4 |' Z& X: l
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。; d# F3 g. ^/ V+ F
- I1 n( r* @" |- a. S ~- ~ 生成的代码片段如下:
2 }: R# _+ j! g1 f9 }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; 五、打包% k9 b5 O9 b$ k
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
- N6 O9 I8 j* ~6 p2 j% ^六、发布
2 |/ a$ N, }- C/ |8 a4 D 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
9 D+ p4 w; U! `, C$ I9 R; D# u
0 d! a3 o1 U7 g
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
- }4 @/ m! l- _" J
5 i" n8 i/ N1 z& X* ?+ o
七、结语* p7 U- L2 K0 L* g" Z: I
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |