|
一、前言
# b/ c. V/ H" D) s& { 本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
U4 B- S7 b! z. G2 o c8 F二、环境准备3 E( e. F/ @- f! f
- node
- npm
- yeoman sudo npm i yo -g
- gernerator-code sudo npm i gernerator-code -g
# T/ k# o; {% h% S+ W) R 三、开发者账号申请
" F" _' J, { {, L& C- E 点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
# U& c; q4 h2 ^1 l9 `1.注册并登录 Azure DevOps。
) U/ t- `3 j3 ~7 U+ Y2.选择或者创建一个组织(new organization)。; ?, P$ Q1 \% l
3.在该组织下创建一个项目(new project)。/ H, d4 F% t. Y1 |
以上三步都是为了获取开发者(publisher)的token,获取token如下图:
) o1 Y* g* X, ?4 r* c
# x; q3 S: H! N. ~4 T: m4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。* A# x6 M- Q; f# a8 s
9 p& H K; c4 c/ }, E, d3 Q" l. r
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
: r/ _# B9 `" ~/ e" T% N$ K! g三、项目搭建
0 L; i! F* J! a; `3 @1 U1、项目初始化
! j) g2 A3 c3 D- I% F( D- 终端输入 yo code。
- 选项如下设置:language选择javascript,名称就是你扩展的名称。: C7 ]0 |& Y& |( g _
. z3 @8 d" r$ E4 v+ s; U) h2、项目改造* p8 P" W4 _" {$ O# @
将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
" P/ h2 X3 b, B5 F1.将package.json改造成以下模样:( b/ _: v: y: u7 E* e
- {
- "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包会失败。 8 E6 p9 c4 `$ W9 d& H! R
3、编码( c# ?3 |3 ^# Q" \" _- i
这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入: . S' Z( l5 G* [) i. v! d V& O
- {
- "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。 & b S# Q3 }! X* F: H& s/ G
四、调试
3 w5 j+ B6 A. ?" Q 单纯的开发代码片段的话测试和调试都非常简单: $ I3 g1 ^/ P/ C
- 首先先自定义全局的code snippet。6 X1 c7 H' A1 {. i: ?! W5 f
0 k4 F3 o+ O) Z4 j; b$ x: _# g
- 选择新建全局代码片段文件。
+ i) A ` [0 Q2 h. f$ v n
3 X+ `' _5 Q8 @4 N# |. O
- 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
6 F2 a0 ?! o: d) Z& q
* {9 E- d8 a7 j6 @3 l, a% b
- command + shift + D 打开调试模式。
- 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
- 在扩展开发宿主中创建适合的文件类型如:test.js。
- 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
$ W, K, _2 r. ?
% C7 L+ y: \ }2 _- J; n8 G 生成的代码片段如下:
2 @+ Y' y: Q/ u0 b5 b8 j- 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;
五、打包' T+ B: b& R' b- u
终端运行命令 vsce package 之后会生成一个打包好的二进制文件。 2 \( \: X3 \. N7 G. Q" d
六、发布5 w6 {( v0 {% v- W
终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
: k' @9 P! s) Y8 y- [ v1 C6 F) R4 Q
- `2 d0 \$ Y9 I. n
点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~# y* m l/ e8 T" H
! X8 `4 i( ?& K8 ?8 m
七、结语
* e/ c& Z7 r3 V7 i vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。 |
|