一、前言6 p7 T* ]+ I4 m/ t
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
8 K, f1 U" W5 ], p二、环境准备1 s) X% q9 F7 I5 M" Z$ }- x R
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
$ @8 S6 j" N: O; c8 k' T 三、开发者账号申请1 o) L6 u" g% U/ f
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。 f y# t& [$ E6 y& Q. j& g% C" ?6 ?
1.注册并登录 Azure DevOps。 F) D# _, V! }, L! y- d Z/ ~$ @
2.选择或者创建一个组织(new organization)。
& u' m* h# j. t$ n" Q3.在该组织下创建一个项目(new project)。
- g" J# a1 J/ V3 J1 [ 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
' d8 C7 \4 B. _& Y, j4 |
6 N* Q3 w# N' x. @$ N: p; s
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
7 @# R1 p r3 a/ |( K1 e
- e6 Q+ w: t- i: }0 {2 J$ q5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。& }& J4 D! _! B* R8 x( b
三、项目搭建6 j# C5 F" F, s+ j: I# H
1、项目初始化
( j1 [$ d3 D% n( E; i- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。- ^7 x4 _) U* ?( m
5 z8 D# \, ?6 o! f" B! t P2、项目改造
( Q# c8 _. Q3 G# \4 A8 ~+ o U3 k 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:& ^& j; G8 E+ x5 z
1.将package.json改造成以下模样:% ~% M, F2 g( R7 a# ]2 d, }" U
{
"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包会失败。; O& S; D9 s! ^5 t
3、编码
% [* Z8 f. u, I% q) H+ ? 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
" D3 @# M1 F! S9 \2 O! [1 y& P: d{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
* z9 U5 w9 E3 a0 {7 {( m四、调试
( @; p9 e4 b3 A; c4 g* U# V. J 单纯的开发代码片段的话测试和调试都非常简单:
& c4 J& ?" @3 n) U- 首先先自定义全局的code snippet。+ Z. P* v" M6 q5 b6 A, p& p. i3 v
, I- ^! C. {$ `# B4 ?- 选择新建全局代码片段文件。
9 F1 q4 |1 h/ Q' c# R$ D
* X. A+ M. k( D# j: o5 c' G- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。1 |0 l8 R- e' B
* I |/ C5 F$ M2 F9 G7 ~- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
0 F f, S2 F7 [( \/ c4 A2 i9 S2 l
: C; r) B+ h8 Y
生成的代码片段如下:4 [, U. @1 _7 j2 j. h
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; 五、打包
1 L0 q- e" u" B# a7 z 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
) Q1 e- I$ o6 U$ t4 N9 I六、发布 { B1 O# \- s& h1 R$ Z" b! \+ u
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!* J8 u7 k# T7 Q4 f7 T8 C8 j
( A' E% C' `1 i! \6 [6 o 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~# ~! K6 s. V" `, p: c
+ N' E, R$ L; p \7 K
七、结语
4 }. j8 T E7 q5 q6 C( t% M vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |