一、前言
$ T* D- b& l( {5 B: t8 M 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。 b6 l2 J h: L4 E2 L1 G% K) r
二、环境准备( E8 v* ^4 B/ \7 x! C. D
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
/ c( h( G3 X9 |' ~% X 三、开发者账号申请" R x$ d# @' I; s. R# F9 C8 q
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。- I( ~4 t! H2 @+ W( M
1.注册并登录 Azure DevOps。8 W! t0 A9 n; ~9 s
2.选择或者创建一个组织(new organization)。) L2 O8 W( |5 _
3.在该组织下创建一个项目(new project)。
" g4 I% T* X8 [1 P6 `2 B 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
% _& t9 \. [; n
" _3 P- Z m0 C) J$ b2 P1 R
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
$ s# q7 ], o% C% s- g" x
7 C; S0 z) H! A ~( Q5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。. [ J5 Q& b* \, ^1 @6 T
三、项目搭建7 C# q3 C4 }# S( I9 F* @ M* m
1、项目初始化
4 `7 ]+ }9 p" C3 Z( p- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。, Y, }6 j. O, @, X* }8 O
2 I9 n: s; Z9 d2、项目改造
- O% u5 I: C/ W 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:8 U+ u" @9 r, R, W7 e- Z
1.将package.json改造成以下模样:
* @7 D! r7 [1 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包会失败。7 Z8 s2 y6 _1 P3 k
3、编码
& w7 ]$ m8 n8 z2 y, v$ }3 g 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
/ v! r5 R5 i! H7 s, x: k{
"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: H2 h7 x5 K0 [9 m四、调试2 w6 w) J' n$ Q9 V
单纯的开发代码片段的话测试和调试都非常简单:
- D/ X% r0 Q8 l$ o3 z1 o/ N( O- r0 P- 首先先自定义全局的code snippet。4 z8 F. `3 |: @* c
! W# N) o0 x+ g; g
- 选择新建全局代码片段文件。- o- k5 G4 ]; n1 t' Q
; h4 y: ^7 E/ z3 k
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。4 I7 C b8 p# |8 P# Q! r
, h1 u. m6 x! b
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。4 e/ z- C1 j* n5 w6 o, {; p! f
) X5 H1 T w; ]& j% X 生成的代码片段如下:
) X- U4 ~ ^) C: U- Wimport 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; 五、打包0 l9 i. C4 }, Q, _
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。/ {' G1 h) v5 {# v& Q$ e' J
六、发布
, V) E/ I' A7 ]: k 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
2 D8 m j5 x* B/ R# I
$ U8 e& \ g5 w" B% O
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
) ?3 T% @3 O5 g5 ]# x
: `9 K* R9 v, s6 O' a! J" g七、结语
" c, L `' w; R( M vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |