QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4360|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言4 J% B# w8 i, S2 h  p$ y" N2 m* P2 L
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
4 j% ~' I% k5 {. f6 M- r' o二、环境准备
/ \% d3 @, a9 k4 w
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g  ^6 E3 c6 d6 K  V% _# x
三、开发者账号申请
7 B7 n. J$ g, z& h- j' O: s/ I       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。3 u2 [. H! g  ]& _# t
1.注册并登录 Azure DevOps5 `% G9 s  T6 ^6 i. J1 }
2.选择或者创建一个组织(new organization)。
# x( u3 J5 G; Y6 R% q( b3 W& Z3.在该组织下创建一个项目(new project)。9 h. [8 g( `" Q7 s+ A
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:7 i- o6 `& @) a$ Z7 S% x
1.jpg ! O3 n. ~* I  C
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
8 a: S. @6 A2 A! f2 o2 Q+ {' j7 p 2.jpg
8 v! r; j/ o8 s  P; P5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
* N' U/ I0 W( w9 z9 i1 e: l三、项目搭建1 M2 V' S1 g% T) c4 X1 ^( B& q2 y
1、项目初始化
1 J  T- Z: f3 u7 c# K+ j/ s& N# y9 s
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。8 f/ |( P# c" {' r' _! @
3.jpg
8 |7 M. L/ P, Y" q- o2、项目改造
0 V2 n- j9 F* e6 S5 K9 \; ?; L8 ^       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:/ l# q: Y) D( b7 ]! P* E3 B
1.将package.json改造成以下模样:
+ H8 m) B: D4 V9 `
{
  "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包会失败。
$ o1 j! i( v/ b4 B1 C: ~& c3、编码3 Z) ^" n+ n& I, l5 n" Y
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
6 B( z- g. o7 O; I
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。9 I+ \6 A$ P+ x0 r( g
四、调试) Q4 V" Q, v: k+ D/ d3 W" G( r9 r
       单纯的开发代码片段的话测试和调试都非常简单:" M7 Y$ e' c% c. t9 h
  • 首先先自定义全局的code snippet。6 T9 i. E5 l( n) [* M$ {, Q
4.jpg
0 f+ y, Z1 ^0 D$ i, ?! @0 }
  • 选择新建全局代码片段文件。
    , Q% H8 m* O  s; |9 L/ e7 T8 m0 ]
5.jpg
" W( C8 s* A2 N; f$ Y
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。7 g2 k- v! M( g% O4 ^) M* B
6.jpg
9 e: C5 b0 m: T$ A! Q6 U
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。, u# a' D8 F( q  h6 T# G% @
7.jpg
" x# T& {" u4 y* @  D6 D       生成的代码片段如下:1 D$ R% V+ f! a" A4 b
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;
五、打包
$ f2 i' @0 c9 Q. t! E8 N       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
7 B" H7 g: i2 l5 w4 s六、发布
% F8 u: l) J  w6 R       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
+ a) |4 t: W' s6 z& e 8.jpg
, F' w+ ?% N! G8 b2 V0 r$ f7 x       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
% }3 k3 t9 c' A  P/ R( {% d) Z 9.jpg / L/ `1 N% a8 h3 n; y6 `$ D
七、结语$ T! |' e1 H6 P2 T" ~) `- W6 K
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-3-3 18:13

Powered by paopaomj X3.5 © 2016-2025 sitemap

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