一、前言/ z+ K) t/ ]' g1 R8 P# N
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
- @3 a: m! r6 U% e5 s/ }% [2 B. }% _二、环境准备
$ |. b- v0 S3 X. }' b- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
; m, Y( B( R& _ 三、开发者账号申请. C3 t, l# ]" o$ B, L7 S& {% r
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
7 q8 Z3 X. l8 K2 @1.注册并登录 Azure DevOps。
- X; Z# R) c% _( s2 I. m2 T2.选择或者创建一个组织(new organization)。 ]. V6 c2 C1 m' x" y0 e' R3 n
3.在该组织下创建一个项目(new project)。
4 u: w, I8 R3 O+ _2 p9 F. Z8 C9 h# O 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
5 ?4 F4 I; H+ s5 a, B7 R0 N2 {
5 W# K! W6 n& ]
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。) \. }3 ?: z* I& ]/ G) f$ c g
8 d8 g# b$ l% x5 a4 a5 C; z$ V5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
9 J8 E4 t9 f6 |5 D" p* T; J2 J三、项目搭建( _$ \7 p1 W; m* G5 d6 D
1、项目初始化
5 S" S7 J/ r5 w5 `- h- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。4 n3 D! @1 E$ |, |, i3 K ?2 T$ e( F* j
# G% n" m* s1 T# g! i2、项目改造8 B) @- d/ w: A" ~
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:' S* h$ E) [$ o0 v( {, ` K
1.将package.json改造成以下模样:0 Y* c1 a' V( x# O! v2 Z: m$ Z
{
"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包会失败。
5 E) H; y, |- A, {3、编码
6 O6 \, {; k0 u* z: S& H 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
( r3 V3 R! B9 C. o2 l/ `. Z% w! _{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
; u3 F9 J/ Q& P; Y# x/ Q四、调试, Z2 R$ p" N* I8 P& v) K" A: t
单纯的开发代码片段的话测试和调试都非常简单:4 j; a$ O, u+ z* L; }
- 首先先自定义全局的code snippet。
& r( G) Z+ t& q; ~
9 A% p1 m+ m( _4 U- ~. J3 ]! O$ ^9 X
- 选择新建全局代码片段文件。
& Y$ q7 L' R# p4 Y- V
8 u% V; e8 s- t! e* x0 g8 p# r- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
, I1 T2 H( U0 k9 v+ D0 `( k
& |* Y; V- g7 }' ~1 F2 d
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
2 a* e. S! {% Q) W# R, x
7 j/ E: f9 ]! a- c [7 p$ U' l 生成的代码片段如下:
& d/ x2 c* c9 ^) 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; 五、打包
; Q4 Q+ b% V! `* s3 w 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
2 J: f1 X$ F3 G3 Y六、发布8 V M! d; v. P- J0 o
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
9 N2 j6 u8 \8 q; M9 [
* K ]8 Q$ v+ k7 f- h8 q0 g
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
g6 M M* S' `# `
3 u0 X1 t; \, A4 F* M
七、结语' d! m$ d' X. ]2 y# p
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |