一、前言& ~. X: d" U9 E6 x6 b: `( Y
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
, v* N: l" K6 B二、环境准备
* }/ G8 y f1 b2 ]/ u* N- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g, u2 y% k2 d0 U7 o3 Y
三、开发者账号申请
# R* L1 i' x8 y) S& x 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
$ Q6 P5 u1 [! M, m8 K1.注册并登录 Azure DevOps。
: A8 ?; J: L5 Y1 S2.选择或者创建一个组织(new organization)。
4 c* ]" [: t: C" a2 ]" `3.在该组织下创建一个项目(new project)。4 s# a/ M& T8 _: X$ c0 M; l
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
4 D% ^6 Y5 Z1 V5 H* l# V2 n
. l! D, \$ }3 W0 n* ^
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。$ O2 a1 H' c+ o$ \' h
& y( Z1 C( t# q, E( ^1 W% `5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。* T; J, S; x# K, o! K8 C5 }; ^
三、项目搭建
/ I( A8 D4 v8 W! q# n1、项目初始化5 O% Y9 B; c) F/ w7 I8 `
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
8 O& @9 Z# j0 h% ]3 |8 \- @
" ]* n# K# U6 K: J! s2、项目改造: Z( Q$ v3 S' ?6 c5 q+ J
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
# m+ [9 i, g0 u: s1.将package.json改造成以下模样:; n- q+ \! j7 H% \3 L
{
"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包会失败。" ?; B" y; r$ i a2 \
3、编码0 z5 Z! U/ F- G+ {- D- M x
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:6 d2 k/ r) K; Q( d
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。: ^# W& ?$ D( n% w3 _4 ^
四、调试
# p# A/ h% b3 v; l 单纯的开发代码片段的话测试和调试都非常简单:
6 b" D/ ^4 Z, N5 ]$ ~1 Q ^- 首先先自定义全局的code snippet。" G4 g0 |+ Z' m. {3 m s ~) e
/ W# S7 @' _! B0 G- 选择新建全局代码片段文件。
7 J$ A+ ?- b5 P0 B2 y) t/ b& c
: a) o# U5 I1 |: m% r# y! X4 S- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。) p# C, K: i1 |- v+ l5 ^0 H' b! J0 ^* A
( j9 p4 v3 C& r; `0 p5 v+ e
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。5 r6 [9 t& p; N3 P" D7 q
# u! }, I# {1 M$ { [( Z- q% {& [
生成的代码片段如下:
$ B/ u; {. B' E* h+ U7 g' c2 Aimport 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; 五、打包+ D& m0 W$ ?) J/ q* C$ x+ A% p
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
7 k. k# ~* A8 e' Q! N! _1 Z六、发布
7 x0 r% t& g% c) T2 `9 {5 j8 v 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
" b. w6 p1 e4 [9 o2 s. P% u
* i0 h! _) l I7 G( V6 I 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
- G4 ]1 \: |& A) A) L6 v, T
' ~: N# O8 ^1 k4 Y七、结语5 `9 e* n+ J, H
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |