一、前言 # |- s/ A5 a+ c+ X" x
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
8 s! m# N! S) i 二、环境准备 b i5 j2 o% ^* z
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g
* x5 r* ?4 J6 c8 j 三、开发者账号申请
: ^: _+ {5 U, c& {- T& B+ F 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
0 b' k' C- n' t. d 1.注册并登录 Azure DevOps 。
- i' I- \, f: o. R( r 2.选择或者创建一个组织(new organization)。3 z) u: K5 Z8 i: `
3.在该组织下创建一个项目(new project)。; b+ e' L& b2 S) N( ~
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
: y/ g- w" r5 `% f' O4 b
d8 k3 p5 o1 o$ c; m) Y 4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。6 J( G f1 h" v t! o' P
+ T/ R" g! P# G4 K: B1 W 5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
6 F# v- M( }, e5 Y 三、项目搭建
0 F; G& l$ g" U2 | 1、项目初始化
1 J n" L4 p7 h: ? o 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。
) H2 ^4 c$ Y w
" e: P* `5 c" n
2、项目改造
3 Y/ M A; [) j8 m, h8 R2 l 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
) H3 J) w+ b3 P% M3 L 1.将package.json改造成以下模样:! Q# S7 K+ c7 h
{
"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包会失败。
1 O8 U7 P- S7 B+ [3 Q: p# F1 K5 t 3、编码 9 b3 }6 ?/ |1 S# a& R J# q1 }4 c
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:# z9 G4 A2 {' W) v
{
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
, I/ U' f. }: Y, M; B. e 四、调试
' Y: i/ n5 d7 u7 N% `& ]8 z 单纯的开发代码片段的话测试和调试都非常简单:
: y' x9 j$ \' {% k% \( m7 L 首先先自定义全局的code snippet。# U4 R4 z/ Y% t
* |2 h- z$ }. I, y& X2 ] 选择新建全局代码片段文件。
9 q7 D& ?, k. c
& a/ X: l4 T7 ^0 Y8 B& ?
创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
3 b: }/ Y* m5 r& f
9 ~0 K/ Z4 t9 D& Z
command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
4 E+ _# z" h! V6 ~1 l; D' N
# w$ f, z( k) L# @, r8 X! j 生成的代码片段如下:+ G( ~; F7 p8 W8 e/ e6 y8 c1 J( S
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;五、打包
; _2 L, U; u8 F8 L5 {# j1 u4 C 终端运行命令 vsce package 之后会生成一个打包好的二进制文件。0 }) z) _. E+ p. ~! j
六、发布 6 X& ^# c- p: L# D% Z. m9 F
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
2 a5 y( ~/ M: Z! w3 n& v# U
8 ?, n8 Q& m& _
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~% d/ X( i: E4 ~9 u
; F: f. E3 t/ {
七、结语 ( H1 c0 u& j T" Y
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。