QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4620|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

积分成就    金币 : 2861
   泡泡 : 1516
   精华 : 6
   在线时间 : 1328 小时
   最后登录 : 2026-5-15

丰功伟绩

优秀达人突出贡献荣誉管理论坛元老活跃会员

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言9 q8 d: e- Q: G/ K
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
# c+ R% R' m, l6 l二、环境准备& @; Q4 j" i# o- y% C. e
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g+ [! k" M/ ]/ Q# q5 U( S: b
三、开发者账号申请
) d/ U7 j- O; }; n       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。. a  O: q: \7 z( c; K3 _3 E
1.注册并登录 Azure DevOps
$ ^7 `- u1 a( C1 L2 |2.选择或者创建一个组织(new organization)。
1 B* a! t& M# }9 M' h* P! N3.在该组织下创建一个项目(new project)。- v; M: w% a( E" Q
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
# l- x& ^2 U+ W7 W: a( T: q 1.jpg
* K$ `: U  h1 V3 Z& S2 _- J4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
/ x7 \. g+ l$ g1 F5 U6 u 2.jpg
; _' [9 G5 P8 s8 w& q. T  C- j  M6 z5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
- `( `; @8 ~$ o- V9 t% x( `三、项目搭建7 Z% ~5 ^2 _% N/ p2 R# g6 j1 k7 F
1、项目初始化
7 c1 t2 U) l6 m$ v
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。9 \, I4 J, s1 T
3.jpg   i0 y4 \7 R" m  d% [
2、项目改造' c% M% [/ n8 E, j
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:. s/ O5 Z' B0 e3 ?" _
1.将package.json改造成以下模样:# B7 o( ?: w: P$ U
{
  "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包会失败。- ?  T5 v4 g$ m- r9 `' L5 c
3、编码
( U0 M2 F  _- K# n0 U* p       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
1 \7 I- @+ s8 j. h% P+ w0 p$ i# X6 s
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
7 Q+ \4 B1 b/ y5 B5 S! Z四、调试/ o& x8 c9 V% J) H
       单纯的开发代码片段的话测试和调试都非常简单:
8 E2 G0 m$ [* K3 {# N/ k# g/ g
  • 首先先自定义全局的code snippet。. y$ s$ k9 k8 p1 Y
4.jpg   g. w* H/ d! J- F$ s4 G5 v6 p. A
  • 选择新建全局代码片段文件。
    1 _* I( T/ R- d7 \
5.jpg
% `% E5 }- x2 w% _/ t* T, M: \
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。0 L! S6 B# X  [% Y$ N7 f
6.jpg
2 t* p- q5 u8 ~
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。# h3 R- c: H0 S# E) D% ~# I; b' W
7.jpg
/ P+ [  Q/ m) y0 ]) H3 V6 A2 K1 I       生成的代码片段如下:5 G7 ]( N; i+ L
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;
五、打包0 ]: b1 E5 t+ x$ p; ]8 R: F: O6 D
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。  [' b4 r6 S# c  k
六、发布
! g$ f. [6 g* z5 @2 M! w7 T% P       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!/ C" U* k6 O5 c3 `
8.jpg
) {+ Q' T+ X' T- F* s% N3 [' B( q       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~) @) t$ U' B, Y( E
9.jpg & T$ e1 I. {- n5 m! @0 i% j
七、结语$ ^. C1 I% _4 F6 `6 ]/ c8 e& d* c  w' X
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

QQ|手机版|小黑屋|paopaomj.COM ( 渝ICP备18007172号|渝公网安备50010502503914号 )

GMT+8, 2026-5-23 22:25

Powered by paopaomj X3.5 © 2016-2025 sitemap

快速回复 返回顶部 返回列表