一、前言 4 z) O7 r( @4 R# m* N8 U0 j
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
. P* ~! z# @. B) `: Y 二、环境准备
1 u9 J# ^9 e7 r3 i9 W node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
Y( o( l4 J/ a: X* @) B& R 三、开发者账号申请
# M$ C1 b% v# V: m8 ^# O: |: Q- r 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
# c. n7 b3 C* X: j7 H/ Q1 ~5 J; F 1.注册并登录 Azure DevOps 。
- t' d/ M6 `- i+ p. e2 _) T# [ 2.选择或者创建一个组织(new organization)。; S2 G& E! F7 K8 ]- V2 N
3.在该组织下创建一个项目(new project)。
! P+ x& |4 K/ G3 x j 以上三步都是为了获取开发者(publisher)的token,获取token如下图:# d/ [6 E$ ?# }* w
/ b" m) \3 C# {
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。' l: a+ W* R# s# s1 H6 H8 s
# H! l, {8 U! \+ X
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
# U! ^0 N, x6 ?" ^& U1 @ 三、项目搭建
" n' I+ l$ e: k4 y- h. r, ?3 P 1、项目初始化 ) M, P( M: l4 _( I; `7 }+ u1 r
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
2 K2 m1 }5 D9 a' e2 J' X9 p
- \1 p! c7 m% @1 S" c4 L3 ?# l' ~ 2、项目改造 B2 O0 Q! W2 y% p# Y
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:3 n0 s% [* _" z
1.将package.json改造成以下模样:
2 q8 C- @' V, J a" M P/ P {
"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包会失败。
- V/ C# w- D- N) u2 y- G* p 3、编码
4 \$ a2 k4 L/ j+ |7 W; e 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:$ D# e3 |* q; A8 S( y S% R
{
"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' ^- X* F. `& ^: ~ 四、调试
' G6 T2 t. j' d3 S: Y: Z 单纯的开发代码片段的话测试和调试都非常简单:
6 u X, ~$ G9 a i* @+ l1 | 首先先自定义全局的code snippet。
8 [9 d$ o0 Z( b$ @( ]! M# H/ d
- K7 r- x6 p& r) r$ v
选择新建全局代码片段文件。) n+ d7 `, A0 S5 l, \4 B! m# c
- n5 p6 j2 w L( |
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
1 Q% g H4 B8 R: c
/ \+ ]0 Y- b3 ~1 M/ D$ @4 Z
command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。# {4 Q, v( y4 n" W, [
8 C7 q( i2 r4 j" {" Y% f( K 生成的代码片段如下:" m y. @$ [ u
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;五、打包 6 T' l3 e8 b+ K' a( @
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
4 q) d& S# B3 ~; c u 六、发布 4 {8 m! P& c( A( F7 {( Q$ U1 ^; g% l8 R
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
; E+ s Z* s5 v. e3 q2 D
- G) f/ n+ V3 N: M
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~0 J$ _0 t. a& D. M
+ k, _8 f' W' f: k0 t9 m" @ 七、结语 & x& F$ ?& O, R$ T, f
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。