一、前言
% f2 D7 N$ h" q0 G7 X 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
. @. r6 j, {( p. p7 z+ ]二、环境准备! U, V. s2 X% q1 n2 F) u
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g$ P, S! b8 S% i {. @( j
三、开发者账号申请
3 u+ l* x& P& _1 }( k1 ~& }. \+ R# ~ 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。6 H- O6 q/ W: ? D+ P/ M
1.注册并登录 Azure DevOps。7 S! L3 o" _9 h6 K: ^
2.选择或者创建一个组织(new organization)。
- D1 @4 H# h/ v+ f2 n3.在该组织下创建一个项目(new project)。6 t8 | K. d7 h# d/ g7 z1 \
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
! d2 x% R9 c! I3 f0 ~
! Q+ O' K9 J! s" k5 X6 ?3 L6 N4 K4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。/ Z# `+ E" o$ y9 C) H
5 V) y* x* R$ F
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。0 y, v" o( i1 I
三、项目搭建
: m# @- y7 y; x1、项目初始化# R: u) q; y$ R5 q5 g6 q
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
4 b% E0 ?8 H+ a. V6 x
& }) j1 v& w+ F
2、项目改造
. W( @; Z' i: {! X' v: J 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
! R5 \2 p& O' P6 i: i o% A1.将package.json改造成以下模样:
( L, h3 O7 @) ]3 m/ K{
"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包会失败。' A# y3 L( e. H [7 y
3、编码
# I% X, `- h" K4 n+ s$ _/ d 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
c( _0 v: w% S' l, f{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。; A$ R. ]. u# e' l' ~
四、调试
1 l; }& j0 `1 q8 Z. N% V3 a3 d 单纯的开发代码片段的话测试和调试都非常简单:
# ?# o* \7 h: v; X. d* w1 M# F- 首先先自定义全局的code snippet。5 o/ _" W7 D. s
+ g* x1 W& n ?1 u3 H: i
- 选择新建全局代码片段文件。
) g: |* Q! n- R* [/ |
}% E5 n. F" z# v& Y- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。2 ~# X4 C) X+ e' t- u! @$ b
# q" o7 t' O6 _# L# ]6 {
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。- p% \" m6 V3 B: s& X3 m
/ |$ I2 Y) V7 y& Z7 P3 K7 [1 c
生成的代码片段如下:
8 |! x8 S3 T( W0 jimport 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 k" |9 ^) k( s X
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。( {5 E) I9 O0 ]8 a8 d# k0 ~( w& n& ~
六、发布
8 l1 Z' ]- K5 ^/ B' g( f5 z 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!. J% e \; p v' H' f, f' q
8 \. |$ v0 k: F2 K9 A 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
, n: M$ m+ D1 N. Y
4 a! S: L3 A( v3 ~1 f
七、结语
- i# S. Y. G/ @% m- X/ |7 l$ Q7 H `% l vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |