一、前言
* q* b$ \6 n `4 D* C 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。/ }0 D+ e! J' M: X1 z4 N d; v
二、环境准备* R' B' L5 \' K$ V6 e! _
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g1 J" J& F; b% o3 [6 t2 t
三、开发者账号申请% P) \, Q4 |, s/ i. A7 ^
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。4 K ]( t& q/ F$ q n0 x2 U
1.注册并登录 Azure DevOps。
: n! w+ G0 F7 H5 f, ~, o2.选择或者创建一个组织(new organization)。
* a) z3 y5 e' u# S( y/ n3.在该组织下创建一个项目(new project)。7 ?% T* _+ H# H. F) B5 O! L
以上三步都是为了获取开发者(publisher)的token,获取token如下图:% b3 W% p9 P9 j3 w& C; z6 \- ^
# d# }) A1 Q8 ~! S& B4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
: A( @4 A7 W( D3 R5 H) T
: Z2 ~# u( v0 H e; w8 d5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
$ G" ^4 n9 ?. V2 n- n三、项目搭建& d/ g1 j3 S2 d8 g, Z
1、项目初始化
9 v& b2 x4 X* i/ ? n. L) {- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。( [3 T7 n6 `5 L. M: i( Q
; u" Y3 M( z& Z3 p2、项目改造1 c& D* M9 R# z; ?1 R3 y. A' y, F
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
5 v- Z ^ S2 Y1.将package.json改造成以下模样:
1 Y: c4 O& c$ F" O: I2 _{
"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包会失败。
' l, }6 O5 N/ @3、编码( f1 A4 v+ B9 K; F9 y& a
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
' v) h. N! Q; y& a, w" V# E1 P6 y4 a: q{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。( b7 Y; b+ E/ A: |
四、调试
% R3 e4 P/ f$ {! n" [/ ` 单纯的开发代码片段的话测试和调试都非常简单:% V+ R- M$ i8 x2 w- U7 F
- 首先先自定义全局的code snippet。
& i8 C' v8 [8 o
; _2 V) q- d+ ?( k7 ^
- 选择新建全局代码片段文件。9 i9 b, w/ f$ Z' ~; D+ G* j
! F! |" V, t) y) n7 H2 E- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。+ q5 {0 Q" k7 N7 P6 _
' d% `2 U) Q. @# X `- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。$ _: w5 Z2 X3 ?/ l$ H% \4 e
: V- i- g6 F6 q0 z- X: u. O* e4 { 生成的代码片段如下:
6 {% B$ X( ^7 m; a& t# Bimport 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; 五、打包
/ b2 P9 F9 E7 N8 n9 Z U9 _ 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
1 n) f b& Q9 `! j六、发布+ ^' A( ^# r" _: |
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
; [% E) |/ g" x( z
; q1 Q, I/ o2 m$ v, \3 o6 i0 S& n' V ^
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
* {2 u5 y; a; ^7 y/ q- C( ^* D
0 T/ \; A8 A. ?4 n8 p七、结语
* o; f3 k$ X, e) B4 }, C [ vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |