一、前言
8 G) S( R [9 y! V# {4 k5 H3 B 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。% n- b8 a# V, n$ _
二、环境准备 + ~7 g$ b# _. G; V3 T c6 o
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
$ v5 `9 A. Q' i7 }9 H, T/ A 三、开发者账号申请 1 n3 g2 T, V2 p, K* o5 b1 b
点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。6 e) {: |/ @, X6 |- I
1.注册并登录 Azure DevOps 。
4 e. Z( R7 X4 |7 ]3 ^% c 2.选择或者创建一个组织(new organization)。
' ?; L6 J# \3 A1 X 3.在该组织下创建一个项目(new project)。
& _5 h! r, c) n) M 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
2 E9 |0 X0 l: d: r0 H
* i: j! k" H6 v0 B; r 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
Q1 p8 y% m G0 F3 x! }) r
, \ T& _6 f( B; @# A( k& {( b
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
8 h9 u, T7 F' z7 W- e- D 三、项目搭建
+ P. @) C+ @) O& u2 e' L 1、项目初始化 2 l. u0 W: Z. |9 ^+ t% C
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
2 U7 z0 ^- c0 v# |
, n6 \. R$ A) R+ D5 L 2、项目改造 ' p, ~$ l9 _8 |/ o
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
. G( k( M* }8 G6 ~! p; ^ ~. ~ 1.将package.json改造成以下模样:
1 Z Z6 d& P% B% 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包会失败。
6 S( i7 O; R* { 3、编码
c2 V) l" j: L! z$ z+ c9 f9 v 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
, C9 l# b6 D: [- z% B {
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。. K! N: p8 t5 x* Y5 W' i& T
四、调试 1 m( F3 d( \$ S
单纯的开发代码片段的话测试和调试都非常简单:9 O' v. [ o1 d2 K f
首先先自定义全局的code snippet。
" i- n* [- m& N' U
, D9 e7 ]8 j6 D; J6 [( E
选择新建全局代码片段文件。8 J9 A) O" @* A& S, F$ u9 V% i5 I
. q/ h$ ]5 A* J F$ w 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
" f. R7 G3 P! S8 y3 X
- ]4 k, p! {5 Q) A8 Q- v2 ~+ r command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
" s) O6 f8 |( |. O& F+ ?
% T }9 v7 @/ V. @
生成的代码片段如下:
( _. v. y/ K$ X6 F" 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;五、打包 / S6 W( M/ x3 t) D- d
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
! M# O4 [, @% d) A 六、发布 0 J0 `/ n7 k( |1 c0 w/ q; u6 _
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!8 e% f! ~- d5 @% `
# A; d2 f3 Z/ A% B
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
, w s2 _" O: c! r9 a0 I
8 `# t0 H' o" }9 X; [1 k# B7 F
七、结语
2 t8 ^) L( J: K0 a/ Y vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。