一、前言/ {0 ~! w8 S' U2 r1 p! U% F! P; U
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
6 v/ p. ^7 M1 s2 `' Y+ s7 C# f二、环境准备2 A/ U5 N" T5 q
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g! O, J+ e; U( s. ]4 D1 G; D/ ^6 q
三、开发者账号申请
' _2 M9 T2 x& X7 e 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。9 Y3 K# [! @* Z# `- z; S1 c0 W
1.注册并登录 Azure DevOps。, x$ _* F" \- \1 A2 j- c. J
2.选择或者创建一个组织(new organization)。
. T* l0 D; Y( ?2 v, Y3.在该组织下创建一个项目(new project)。# @6 ] R- ^& ?& s- e
以上三步都是为了获取开发者(publisher)的token,获取token如下图:: S5 Y. l- }2 e) @
7 z# H% q$ t# ^; S4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
- p7 e. e, h( `2 b5 z
: O" g/ v- w# H" G
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。# Z" v# A1 j9 u! o- g1 r% v
三、项目搭建
" C, r; j" F$ t2 g6 v2 O: z1、项目初始化 w7 f+ B1 v0 R3 k, p0 Q: }8 T0 z
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。
' P; ^- W; C0 v+ [' d3 @% @% w
$ `# ?- C t, w- _8 Q& W8 F4 a
2、项目改造
# {( M) ^5 W9 n+ h% M# Z& D2 L) G 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
8 w; C! y9 Z4 b6 v8 Z1.将package.json改造成以下模样:
; I% A4 E, Q8 Y. G2 J* q{
"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包会失败。
: T% V# X8 h" ]0 v- [! k& I3、编码: w9 m8 J! L1 m5 m) J5 q c
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
5 C9 }1 Y5 i/ }6 Q7 u- l+ e 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。8 J( k, k9 P3 O& k1 f2 S3 X1 g
四、调试2 i+ \2 s5 C* F# S3 k
单纯的开发代码片段的话测试和调试都非常简单:8 P; m* ^2 x1 T h4 x- Y4 n
- 首先先自定义全局的code snippet。9 x; @( P8 Q# N3 H$ n
/ T8 Z) V. u, }! x- 选择新建全局代码片段文件。
Z: o5 b. g* w. H' a
5 T& y/ H8 K7 l" V/ \, E" T- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
; `2 v/ o% J9 r b' h9 g
: c* h( l2 r# Y' ~! D" O3 Y- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。8 ?( d) X0 f+ j9 t$ L* [
% i* S# n Q4 J5 \ 生成的代码片段如下: {8 `2 U J% k7 M" @" w
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; 五、打包+ b O J, }- q7 W" W1 x: W" f H1 Q% h
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
8 X+ ^0 O# ^) [: n3 K/ ?7 k% c六、发布- Y R9 L# v: n) S* c. f9 O
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!% E ]' K9 ?! t! o6 E. s+ [
! s9 t, C" s3 h1 x
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
; w4 w# U+ R) o- }: U) |$ s
: l( K, P. w3 Y( m u8 u七、结语2 H& E6 \4 I. ?; Y% |
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |