一、前言/ E+ H; X! s5 h! k
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。9 [; Y# q: G3 X' C1 W4 d
二、环境准备
. z5 X; Z. |; }. Z& Q& ?$ W- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g: s& l' F8 ~- D G: V: t
三、开发者账号申请% o7 W8 n r: W" Q. c5 i8 R
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
9 W4 |2 z+ b# u' b+ J8 q" W1.注册并登录 Azure DevOps。
/ l6 d4 }7 j' x0 W" l Y9 i: O9 o2.选择或者创建一个组织(new organization)。
6 y4 {+ b7 j9 w( [$ g7 u3.在该组织下创建一个项目(new project)。
+ [1 [# Y. D5 @4 K$ ]6 y0 B 以上三步都是为了获取开发者(publisher)的token,获取token如下图:, y: p7 n; w5 T+ ~/ p
3 S+ @4 S' u# y% r
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。 |: z0 P# z+ n: H0 }
E; j0 V; ]* D# i/ v O
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
. Z4 e4 N' w' Z, r. \) V三、项目搭建
$ x5 t; G5 _' x7 y3 C1、项目初始化; `3 {9 m9 Z l" Z
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。! Q* X, y. a1 P B* }/ v3 G, @
. X0 `/ U; b \3 j2、项目改造
7 T' n- Y/ F# W$ y! U V 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
- U, \/ W, I6 ]6 F/ k6 W* Q1.将package.json改造成以下模样:9 [) }2 x8 E! P( q/ v
{
"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包会失败。
2 l& z3 N8 _9 g3、编码
0 s: h C" ^! Y t% K! m 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:7 ^6 O0 Q Y$ a# U4 K" ^
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
* `, z* b& A# R1 g' V) D四、调试
l2 c# o) p5 C7 ^/ S* y 单纯的开发代码片段的话测试和调试都非常简单:
& o! E, i: ?; t* A, ?# h- 首先先自定义全局的code snippet。
8 d# V) |+ o) |* M+ y
$ P" Y- q8 h% |* t$ L9 v3 g
- 选择新建全局代码片段文件。
$ b4 f% j/ a9 D8 S8 ]
" a" Y) h" [! E1 p: X- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
& X) T! g) k6 r0 }& c# j' k- W. c
% V' y, O0 q3 L: m. @
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。: y) c( ]# g& m5 C! B! P
, T7 `/ h) c3 _8 f1 D 生成的代码片段如下:
/ @; _& ~; i: h5 v2 N+ J! simport 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; 五、打包7 \" ?# F ?" [3 d/ y( n1 v
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。* d# O3 { c3 s& K5 D" j
六、发布5 D, q* g/ a! l4 ^6 M$ C& c2 U: z- Y. x
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!: g7 I* P( M1 @( O
* K$ S3 y6 Z; B: Z
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~0 k# e, V3 K' Z9 e: B
, ~% m( o4 C4 }1 S+ i/ {七、结语
% H3 d+ C0 h& ~0 d9 a vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |