一、前言
# q( l: ~4 m, i' M( m# S 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
* \" ?' Y N+ F( T6 i1 e) ? 二、环境准备 - R% K2 ~" }, w9 k, |- [
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
6 @6 U3 Y! r2 r$ N) K 三、开发者账号申请
- C. K g4 c- e1 a. m. C 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。! F3 x1 B, F @$ Y' i8 M4 G
1.注册并登录 Azure DevOps 。 a8 Q. R. v0 y n
2.选择或者创建一个组织(new organization)。9 V% r9 T+ h" _2 M) g8 K% k
3.在该组织下创建一个项目(new project)。
: t, ~- Z3 l) K( { 以上三步都是为了获取开发者(publisher)的token,获取token如下图:! N8 e% h1 ^/ [- t9 r2 z: I' `
8 X/ h0 m8 ^) z$ f- N' Q
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
, M" o# A0 \# a. | o1 ?1 |1 b( O
( B8 w; k5 A8 m6 H9 ` t. L5 m 5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
! ?7 ^' _: [' ^- N) `- g% S 三、项目搭建 3 p* G4 S% _4 b" F8 C( T) ^6 t& z* A
1、项目初始化 ) }. j: T+ u* O& \" a- {
终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。+ E4 O6 E5 ~( N; l. A9 m
0 Z" c) Y9 B H6 w8 I b9 a H E( { 2、项目改造 : r; B9 v1 h+ d3 P4 B' G
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:2 ^& M7 [" ~' U$ U ?6 h a* w
1.将package.json改造成以下模样:
5 u- i, @' r* T$ q: ~2 N {
"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包会失败。# z5 |: y5 m+ U9 @5 v1 n
3、编码 $ S% x% M2 A$ ?# K
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:6 ^& y4 n$ h# @2 V2 ^3 F
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。2 \! H4 e8 D7 }( o
四、调试
, a5 H4 m+ q9 ^$ ^; ^4 b. R 单纯的开发代码片段的话测试和调试都非常简单:
( j9 h' n8 H) ~ 首先先自定义全局的code snippet。
5 d# _' D8 w2 e
: [, D/ V B0 O 选择新建全局代码片段文件。- @2 G0 G7 ?! Q2 N6 h; P- e+ |
6 o9 l7 F1 }7 Q% G, v9 l( k3 F. O
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。: |# U6 M9 J* k2 f4 ], z# U2 g
' {" a$ d1 l/ {$ U command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
% O4 R4 ?, C% E4 _, i* A
$ D; Y* }- p+ U1 ^$ Y) O
生成的代码片段如下:
: ~2 E0 k n0 w" D) F5 Y 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;五、打包 7 p( u- Q# g; n5 U8 S7 w. F! L" M4 Y
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。& ]" a# x% S1 _- l- w8 k& G3 z" t
六、发布
2 r6 {. `4 W$ d& z6 J" z' x4 y 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
6 P6 |, S1 ?$ C; l
/ b) n3 f5 b9 K8 E, U( U- k
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
9 o% l; y: E- H9 k2 Q
% k3 H7 C# ^) d. P! y
七、结语
n- k8 W5 B" C. Q* O vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。