一、前言2 w' I0 z8 q3 [0 {5 I/ ^3 S5 k* `4 m
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
, R1 B" h' ~+ v2 @ l Y; u二、环境准备1 W0 I; l4 ~: `5 @) J& _
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g- ]4 J) ^; {6 ^7 }% V! N$ f, }
三、开发者账号申请
0 x5 i, C! \6 L5 ]( `) c6 G 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
. Q. @) d7 `# M6 O1.注册并登录 Azure DevOps。
: X( u2 ?9 y# h1 b$ u! u- z- R* {5 Z2.选择或者创建一个组织(new organization)。
0 c% k4 ^' |0 a# V; f4 Y" b3.在该组织下创建一个项目(new project)。
) J1 r; p+ n3 @- [ 以上三步都是为了获取开发者(publisher)的token,获取token如下图:( ~ G7 t7 r; z
% q- O, H9 T" w( f4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
; ^8 \2 A2 |5 {% s6 v, }& R3 h( J
7 c4 O) A6 U2 K" ]5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
- J% B3 v5 y9 E6 x1 |% f+ }9 x三、项目搭建1 t0 M2 b. ]5 p
1、项目初始化5 {5 Y, p# B$ m+ @% @ i; Y1 L
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
& `$ p( [1 M3 x* z r& ]
7 U$ K) c3 l1 v9 N3 k2、项目改造
+ \6 b( B# `$ E% {- o6 g5 ?$ R6 V 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
4 j7 R2 s/ M# \/ A1.将package.json改造成以下模样:
( B8 x( |9 a/ B2 B9 B! _{
"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包会失败。4 k/ U# ]% j2 S- k* X' ?) K
3、编码
9 ]$ D- P, p3 Y: N# S 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:& A* a3 f0 X0 m
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。* f1 ~7 C1 _+ X0 ~& X" d [3 R0 o
四、调试
" t: m5 T/ c6 C, R 单纯的开发代码片段的话测试和调试都非常简单:4 f8 o% S" A3 W1 O5 d; V" D
- 首先先自定义全局的code snippet。
1 U: y2 y! U5 [; Y
; w0 `( {4 a7 D- 选择新建全局代码片段文件。
! I4 G, V" G" Y: ~
# f |0 M/ J4 l! W- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
5 R0 N9 M# n8 E/ K( h3 b0 Y' x
2 o D# O4 h$ e/ W. D0 W- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。- w8 N2 ]% s5 ]# b- R
. G& {" r# K/ d( D/ t( }7 ~ 生成的代码片段如下:
3 N. [, {6 U& \3 \: |5 _) \2 timport 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; 五、打包# [. b4 n, a; y
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
0 i& F" b1 b! N( v/ k0 r7 q六、发布
) b3 @' J2 x, j6 [: c 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
2 R) W4 N' F2 M% y% e
: q9 C3 A( F3 h# i5 I D9 H3 O8 l
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~9 `1 o% `2 r" k) N0 h$ F
! k. R* @7 r' \. K
七、结语
& |! ^, J0 h1 I! N0 C9 f8 s vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |