一、前言 , C# p/ E5 J8 ^, q6 J5 `
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。& @, a' w& ^4 p$ [/ \3 z
二、环境准备
, ~0 d3 I9 W1 A: F4 a) c2 K node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g s/ A3 x$ T8 a2 V; B5 k* A
三、开发者账号申请
0 V" E- \1 Z2 g! i( ]( o 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
! w& j7 ~0 e, v, W 1.注册并登录 Azure DevOps 。; v7 [8 ^7 ^+ k3 @
2.选择或者创建一个组织(new organization)。5 D- n$ Y# t- |, _7 B& y( e% G6 u
3.在该组织下创建一个项目(new project)。
2 g ?, [. b7 L: |5 g 以上三步都是为了获取开发者(publisher)的token,获取token如下图: r0 f3 T5 z6 m/ ~% ]0 z/ Z
7 h s, `$ u7 L/ ^- W& |5 D 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。" `, T( P# V1 q2 q/ T8 J
8 _3 D1 b6 b8 K5 U7 ? 5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。3 j2 G- C# g& b
三、项目搭建 ) m: L: T* n& F" k% N; e4 E7 l) Q
1、项目初始化 H( ~% d# V; ` V7 z; k
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
4 R4 `8 a2 r9 b# \ F! l' V
& v; ?+ y0 z& K+ B$ O 2、项目改造 + P3 Z; c8 q% _0 ]) K
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
9 }. q9 `2 p$ C 1.将package.json改造成以下模样:: s' P Q: q* W
{
"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包会失败。
$ w5 W, g; J7 }: p/ d1 i0 E 3、编码 , m% S- f/ q% A: E
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
2 f( [- F/ A1 o% }( { {
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
$ j/ E" E; q. h 四、调试
6 c0 C3 |7 ^: J# P& m/ Y& z7 k 单纯的开发代码片段的话测试和调试都非常简单:
2 m) Z# @+ o( G5 e 首先先自定义全局的code snippet。$ D& B) w8 s, E
5 }- F0 A9 W) A( i3 y; g# D' ^ 选择新建全局代码片段文件。2 ~$ d# k7 {+ e) k5 q
& \2 q9 D& j' v7 u, I
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
" c u9 [8 ^ ]1 z( U8 B0 b
; _4 \! t: O. s8 ^6 ^8 D
command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。: E: ]& {% @8 T& e
9 R, }" T, T6 z2 S: R5 s/ C$ ^: W5 \
生成的代码片段如下:
- s0 @* [7 H9 C 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# _9 W7 H3 I, R$ s
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: x* d1 K. ]' p
六、发布
7 B) V- N3 n, s9 f7 t8 H! Y 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!" f1 `4 C4 Y0 y, ?+ S9 W( Z
; t) l; s) O$ j
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~+ n( O) y# I. J# ~! C
3 M+ I, }4 s# l7 I
七、结语
, g6 h0 U' f: s/ R9 V, ?# V vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。