一、前言
4 c1 R" a I! P* E( a! _% D4 F$ d j 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
# x: H4 N+ a6 }+ M! V& M二、环境准备& P( D# Q& W1 i" `+ ^3 D# G+ k
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
9 u/ I* a5 Q/ Q8 q; w( n0 J 三、开发者账号申请
. k) {" y+ X9 h X 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。- v- }7 ?7 N- U* T
1.注册并登录 Azure DevOps。1 [5 L, a: K+ W" ]
2.选择或者创建一个组织(new organization)。; C# j W! m: p. |, ?/ R
3.在该组织下创建一个项目(new project)。5 E4 L! q, n2 n0 m
以上三步都是为了获取开发者(publisher)的token,获取token如下图:: \5 z8 p& n4 y" i: x- G
8 ]! L3 J T- D1 ?$ _; M; U4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。3 a* F. G8 I Q) D
7 T" }0 H2 @6 ~( g4 Z
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。8 w7 n2 F' K; h1 `+ ]) v9 q
三、项目搭建
9 Q1 n p7 f: S; L# O: O1、项目初始化0 v( s! p$ n' m/ K8 Z
- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。0 x$ a5 j8 i8 V' W ~
. |7 I5 @( C% m- l/ k9 c$ n" Q2、项目改造
; e0 ]; X2 {0 D 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
, m# k, o" A. F8 _1.将package.json改造成以下模样:
- B: o- `1 I* B3 @: {{
"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 q& A; o& r9 M# K- w& }) F
3、编码9 d+ t! T+ y S* q& m
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
6 j0 Z5 y/ P+ _2 m' j+ n& R- q+ G{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
; m- r9 m7 U: T四、调试: _8 U4 f+ @& V+ V, ]" K; L
单纯的开发代码片段的话测试和调试都非常简单:
+ m9 [7 ?+ R& H, K- 首先先自定义全局的code snippet。3 u# V. x, f# P+ a5 r( |+ v Q0 b0 y
- x9 c5 e1 j8 s0 z# L7 ]1 T8 \" a3 r6 g- 选择新建全局代码片段文件。% q: Z5 S. T3 U5 V7 j
2 {- l# p$ d/ m1 q
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。4 O( h, B+ ?7 ]6 r3 w" s6 ?) s
1 h5 |9 r2 {4 L- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
6 e' e. ]- r' {0 _* e& }' b6 f; G
: w( A% f( }% v, {% E$ B
生成的代码片段如下:
! R" N4 a9 `; _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; 五、打包6 c; d8 n. H# [# r( f3 ~$ @
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
3 S4 F2 s1 B! {/ \( X0 ]' \0 v' \六、发布
; Z) X# h" Y. ~5 ^6 l* \+ V& l 终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!5 t. ~$ v8 c& l' n- a8 X+ e
. d' ^6 \ l6 A, y/ l7 ^: J 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
- M2 X0 n+ u& e+ R% j
/ ]" W8 {; c/ s# |5 O七、结语
+ t9 ^/ p U: q) i! G1 ~ d vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |