一、前言: [6 z2 @! i+ f) ~# r
本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
' E" ]. D$ F2 o; m5 L二、环境准备
& D& [/ _# v% `! t- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g. h# h6 c/ r' i j1 s! b
三、开发者账号申请' |7 z0 h' F; S l c
点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。- ~9 q _, g3 Y9 m% e( L
1.注册并登录 Azure DevOps。
. M& c# B L) F' @( h% y2.选择或者创建一个组织(new organization)。
# J1 w) g5 f: q# ^5 e% ?3 S" B3.在该组织下创建一个项目(new project)。
, [" j0 ?8 ?7 o! j) x g 以上三步都是为了获取开发者(publisher)的token,获取token如下图:
* Q" Q' o }( m/ b
; b7 i+ E4 D: Z. z% f8 g$ N4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
( Y/ t, J8 f3 ~3 u% I) a. D
\- a; ?8 e) e7 |$ ^. u% y5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。# y2 c. Z C- o/ b4 U( `
三、项目搭建2 }4 }) Z5 M/ j9 x
1、项目初始化
4 @9 d4 X+ W" s3 t1 G I9 e& a- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。. b* i1 S! T2 o* F4 o. n/ g& A
. l* F! e# x. }+ w3 J8 G. @
2、项目改造6 @) |/ n" \0 J1 q2 q2 K: j
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:2 c4 `* S6 ]' U, ]- z0 u. o, l3 s7 C
1.将package.json改造成以下模样:* T# d% ~# j9 b3 [# s/ M
{
"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包会失败。
9 G6 f! w4 \3 R5 X7 q K, d3、编码
! S1 j: R! q1 D, Q( [6 z( T4 d' m 这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
- F8 n/ x: T S- K' 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
5 W$ Y$ `5 B9 h2 V* I+ e四、调试6 k' H( f! n7 u! |* D0 @( t
单纯的开发代码片段的话测试和调试都非常简单:
, ?7 B7 }% }7 _0 O/ R1 N5 z1 X- 首先先自定义全局的code snippet。: q; ]+ q1 U" ?- a" x: ~$ C
+ ]$ H( n* u ?5 a- 选择新建全局代码片段文件。; s5 X0 M- V% q& P" h& Q# F
, s" y$ Z/ w- e7 Z
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
. Q) W- v) y$ h3 o* H1 w
8 C8 L6 I: |6 c5 _* {; F
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
6 ?7 W- k! G+ y. {/ @
: N- u( a! ?/ @+ @: |* \( x 生成的代码片段如下:
8 D' A, D. J% A/ Eimport 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; 五、打包; T8 E& m( |6 S: T. n5 S7 Y
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
6 w- f2 w% D% Y9 _, M m六、发布& t! i! {/ N% A- Y) s; `$ b: R
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
& S" o; ` B3 u, M; h" s
1 l8 e5 b& U f9 n- F 点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~/ ~$ k' U4 w+ J+ u8 I7 g- n" V
7 `! g' N; I7 N; x7 k" n七、结语
) [% D( p: h* }8 J. f vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |