一、前言
$ J& K. F u2 N4 ` 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
, L4 m7 l" d# W% j 二、环境准备 $ Q1 w- [3 D7 |: ]$ n
node npm yeoman sudo npm i yo -g gernerator-code sudo npm i gernerator-code -g( n. H5 n+ S+ V' `$ d- p) L: B
三、开发者账号申请
; C! G) x7 W! V0 S 点击 Visual Studio Team Services ,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
$ s7 g4 w1 @4 N 1.注册并登录 Azure DevOps 。+ U" Z3 m- ^. |
2.选择或者创建一个组织(new organization)。. h0 x% T3 ~+ c, d2 g2 ~+ r
3.在该组织下创建一个项目(new project)。% l$ Z% E& ?+ H/ Y7 n. C
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
4 ^0 S- ?% G/ k# Q7 k3 p
! r1 z; m( \9 `& [# l; l( x& \* Z
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。' o: ?/ v5 C- @3 J; ?
/ p/ o% ]" O9 U3 [: y
5. 注册vscode插件开发者(publisher):点击此处 。注册保证name和id一致,并且只需要填写这两个就可以了。
: w" F3 l3 h7 a1 }: O: Q+ J7 @ 三、项目搭建 ( x$ S4 T7 U$ t8 `$ Z( `% _
1、项目初始化
. z$ P, Z( y2 w 终端输入 yo code。 选项如下设置:language选择javascript,名称就是你扩展的名称。1 D% A% N3 m. z$ W
+ B* v' x9 t% p; R3 c" j 2、项目改造
- q$ R- D1 f; x9 V& ` 将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:( Y- s3 R" C/ P4 ]2 {, \' n
1.将package.json改造成以下模样:
7 D$ k. B5 [ b' j {
"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包会失败。' N& A) L. I! H
3、编码
9 Q; f. I7 H7 M _ 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
, @9 b0 z$ t8 h' g# H; r {
"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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
- q9 B. `2 }% `1 L4 D3 z 四、调试 4 m; u( F; b" v- f9 k; C
单纯的开发代码片段的话测试和调试都非常简单:9 R% u7 \# n/ @; T3 D( _2 \
首先先自定义全局的code snippet。
- D# @2 K) ?) v/ G& u# Q
, S6 u3 s* W9 h* \/ R0 R- h
选择新建全局代码片段文件。! B3 T* \4 c6 G$ O* y
) b3 `, Y1 V7 t, l6 v0 E 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
$ Y. m1 L" s6 W" K0 H* b1 S
" }* a# a1 A% c* | R# f/ Q command + shift + D 打开调试模式。 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。 在扩展开发宿主中创建适合的文件类型如:test.js。 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。# E$ Q6 i( v2 m+ z; @: l- n5 ~9 ^
# [- @" m4 Z3 D6 [& Q" Q6 t 生成的代码片段如下:
1 G" R$ O; N6 X* G Y7 @6 d 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;五、打包 : j/ @. \/ z- H! o' Y$ `5 o
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。5 j! x9 g( e% i0 ]5 \8 e" M
六、发布 , D5 p, S7 |6 m* a5 ~. C
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
% w- D4 S" h, W$ `6 f
( ?* m, K0 D3 h/ R
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
3 A) U; ]0 b9 F1 O$ r6 e/ g
' {- F q5 W& [4 _$ b) Q 七、结语 ) ?* n. k! O2 r' k4 r
vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处 。