QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5167|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
0 ?2 C- R7 B5 o1 m% ?       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
0 F$ ^2 T; m: r# j! Y% }' r* x二、环境准备
% [" _/ }  Y6 I& d, J) K
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    0 v9 g8 E2 \4 U# ?8 m) X
三、开发者账号申请( q) m* v6 f/ `" ^; P
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。3 ]! n" l2 R1 Y
1.注册并登录 Azure DevOps9 K6 F) o0 w6 z8 i3 G1 K! n# u
2.选择或者创建一个组织(new organization)。
* L; l' O+ I2 z4 g1 O/ _: y3.在该组织下创建一个项目(new project)。& J" L# N( q3 y! q
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:& Z' [6 Z' D" y; D# ^! e, l
1.jpg 3 C6 t4 n# F4 Y& k2 A3 w, ]1 c5 {
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
: X* f! ?9 j' X1 ]$ C 2.jpg
- M' M2 i' v3 @0 X1 L, C1 K5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。% D$ f% h; d0 p9 m
三、项目搭建3 E1 u( d3 m1 M7 j  A. w$ T' t
1、项目初始化
7 e; P7 [( C' I% C( n" f  u/ j
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    6 ^" G5 G4 m8 a: J) v: V) T4 q
3.jpg
, U& K5 C* v% x6 x1 A2、项目改造* G4 N& c4 S% G4 c9 A" Z1 W. I% R
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
" i8 i& X6 F. Y( s) f- ]2 T1.将package.json改造成以下模样:" v$ R9 {" ~1 P4 c  W
{
  "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包会失败。- b- E) `: I2 b0 [- Z
3、编码" s& s8 S& p+ T* q" C
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:1 ~* M5 f+ F- k+ }/ a; H
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
0 u8 v# h% N: z8 x) V四、调试
& F; s; t9 F  z  C" q       单纯的开发代码片段的话测试和调试都非常简单:
- t" s- t) [! a5 e; c) Y9 c
  • 首先先自定义全局的code snippet。
    3 u" k; m4 y0 X, T
4.jpg
  e6 `4 E1 D1 Z6 K) M
  • 选择新建全局代码片段文件。
    " |- C7 X+ F# D' N" G  ^! o7 H1 F  Q
5.jpg ; E0 T% N& b* ]) J. Z
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    " o- ~. i" C! M* Z( z
6.jpg
( a. c0 h3 }8 b8 u  f9 D
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    4 E4 K) R, j8 f  a8 \
7.jpg 1 w/ s& d2 h& p5 }& e3 `* B% C
       生成的代码片段如下:
, F% `: X0 R2 o; x# c) U# Q
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;
五、打包' g9 z; [5 V: u/ v: H
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。2 E. R% R% i, z2 ?' ~
六、发布! Y* R9 l5 ]) v" A9 k8 V
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!" _2 e8 Y# v7 _) C
8.jpg ! {) I2 f2 y. ?/ ^3 Y7 |$ F
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
2 R' c: M' _# f 9.jpg
8 C2 E0 ^9 C' i! i5 B+ O* |七、结语
  \% k3 C9 R+ q; h6 i       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-27 10:34

Powered by paopaomj X3.5 © 2016-2025 sitemap

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