一、前言. k" T, u3 M, K- H. f
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
; ?# y+ J& r8 Y# E! Z- n4 K二、环境准备
$ Y. L2 j u5 ~1 [2 E/ Z- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g& ?1 D$ J+ n5 \. e9 t
三、开发者账号申请
) i/ m& U7 d$ A2 D: V 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。+ B+ M! N9 \8 ?9 X- e, |7 e7 a
1.注册并登录 Azure DevOps。
" }) M/ k3 r; W c2.选择或者创建一个组织(new organization)。
0 z9 Q0 |8 y! K E3.在该组织下创建一个项目(new project)。
! ^$ F9 P- I* T2 l; T 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
* }/ y) T4 y2 `* }8 Y* |- [
6 q7 @/ l$ @$ j9 s( z0 T% s4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
+ z( @1 e- y0 S& g: D: n$ m
, }* j9 I( O0 Y2 `. U
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。6 d: a7 _. T) t" A
三、项目搭建
7 Z3 j) Z! ^8 u% K$ y6 j$ T8 i1、项目初始化$ S) {6 c; M( c( C& h8 ^* Z) y
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。* m2 M, a& W1 f
3 c& ^8 O3 }$ Z+ h2、项目改造
8 F8 _* y; z' Z2 P7 m" S 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
/ k% i/ ], l3 }1.将package.json改造成以下模样:
; S J" G- q8 ]# M8 E7 I A. ?{
"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包会失败。1 [8 f" |+ |/ v+ E6 W& {! q% a1 f# c
3、编码
5 W$ s: X' `5 B8 U 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:; ?/ t6 k! Z! o0 v
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
4 [$ p2 V# [/ M+ \% q8 G* g7 B N四、调试0 T: z5 i- `3 C. I* G& A
单纯的开发代码片段的话测试和调试都非常简单:$ d& ~0 b; L0 ?3 z6 B; S' ~+ u' Y8 Y
- 首先先自定义全局的code snippet。
q6 H3 c0 P* D9 b
8 A4 e) N& I ^4 I, k0 P- S1 V% P
- 选择新建全局代码片段文件。/ k: P f% o* t5 ? }; U/ ?
0 ^' |1 \ m% e+ W+ a6 _+ K" z- N9 O
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。& ?, C1 @' z; n, p
$ d. b/ P' D* N5 {' r4 J- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
\3 i8 @: X9 G. q
/ w: g. [: Z. Q5 P' i4 u" i 生成的代码片段如下:* V A9 b5 K* O7 e y+ I1 s
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; 五、打包2 h) b$ V @4 u! q5 P" p' b
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。 N; G7 B. U& B3 y& s7 e1 ^- B
六、发布9 I, F# s! i- F( C5 }
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!8 e6 }6 A. N' }; Y5 l
6 C; _# l7 X3 y" ^
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~/ X8 L0 k3 I% F. t% m
" q& p- Z/ {$ u# x; k
七、结语
& j2 }) A B4 m% D3 `( w' [ vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |