一、前言
. [- d# ^" o0 [) ] 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。6 W$ B3 {* A+ p7 m6 W3 N: Y! h
二、环境准备$ _7 E3 e& y: X2 t2 i/ ~6 D& q5 Y
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g& M$ O3 ]: X! @: L) z0 ^+ ]" l
三、开发者账号申请
+ b8 n4 \, T0 w" k 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
" {. K7 B( d- p! w1.注册并登录 Azure DevOps。
0 ?1 K3 N6 M% Z% z! f2.选择或者创建一个组织(new organization)。6 C( O3 {( P0 i: H) n
3.在该组织下创建一个项目(new project)。
! h$ \: q) I) t8 Y5 d3 y/ e 以上三步都是为了获取开发者(publisher)的token,获取token如下图:* q) P x* j' }( U7 f$ ?- k/ H& K3 D
3 W6 C0 e C6 s) C" J4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。' c+ h7 S3 r, j) \* J
C; |6 A- i3 |) S2 p5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。0 b# b0 H9 U0 p1 Q
三、项目搭建: ~9 S8 v8 x! E6 S4 b* K% k2 F2 Q
1、项目初始化
6 _+ M* O5 x6 N2 X- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。( A8 [& }) T. j" o; h N% O% g
" Y2 y! @8 V4 O! ^: g; A2、项目改造( g( U' i' e: l# z7 K
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:% i1 y T- F, ^+ O' G0 l
1.将package.json改造成以下模样:5 H8 ]' E+ A6 @% J2 u( @9 K( o
{
"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包会失败。& M8 X2 G f/ M, d& \1 w
3、编码
" V) z$ N1 Z8 W2 d8 K9 ~7 ~ 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:/ i2 w- x1 W" N) o/ d1 g+ a) d2 s% u! l
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。6 W, v1 K8 N+ c+ N, a
四、调试2 |: `- N# z! M ~5 \
单纯的开发代码片段的话测试和调试都非常简单:
" ?/ k- i! G0 J+ @& v8 M3 P- 首先先自定义全局的code snippet。5 A! {7 S' n9 r" [0 c" _' q# {
- a. R2 {. v0 p9 c5 M- 选择新建全局代码片段文件。. f; F! |6 e3 |5 O7 T' F; v+ `
7 y; g0 L( J- U/ L6 z) U, G- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。3 ?( [3 y; N6 ~% `$ P: z
; h$ k5 s3 r) z$ g. X
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
' o! c" I( r# Z$ L$ v1 q
; U; J- _3 B" h) f l1 W( m 生成的代码片段如下:+ k! q! \7 d# j, }+ l7 E2 O
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; 五、打包 K! e6 b0 h, {0 F/ X; t, u J. P1 a
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
4 |1 \# o5 r3 L6 ?( C- m) L六、发布+ \2 R/ n+ n6 o! i- ?
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
% r# ?7 @' R F
; E" {. D, S2 H h8 s$ y" }4 I3 s 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
; s5 Z8 \$ Q/ l
6 J# F+ A' F3 j4 e- X
七、结语
, Y! A2 z( u8 u0 J& y$ d vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |