QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5146|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
) a2 w" k  q- A% ]9 n! S       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
1 q, n, F/ d8 P3 n5 H: F/ i二、环境准备, h, H; ?( i! V# d' ^$ P
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g) z# ~, q# e5 {
三、开发者账号申请
: X6 P- t0 W* T% ~+ _       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
7 c3 N  _  N- Y; ~) r, B5 T1.注册并登录 Azure DevOps0 @3 z7 I7 O4 A8 M: c. V% e6 ?% I( j
2.选择或者创建一个组织(new organization)。2 W8 J" \# q+ a' r/ S- v
3.在该组织下创建一个项目(new project)。
  ~  N+ z& v+ E% u7 E9 G/ K. D( g       以上三步都是为了获取开发者(publisher)的token,获取token如下图:' S1 W, ?3 r, N
1.jpg
* b" s0 {, A0 G, T; h4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
1 S, I$ t8 M; P6 l2 ^: K3 n4 `- z 2.jpg
/ D' X; j* n3 l, t) _* @7 D# P5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
, U+ d: L$ m: y; _# P0 a三、项目搭建
/ `& o$ @7 }& M2 S4 [1、项目初始化
0 L, x; ~; y+ E
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    : ~1 Z( n6 @, T( H
3.jpg
0 T' p3 i/ l- C# L" S5 f1 i2、项目改造
- I* `" P! F. D7 Q: @1 L       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:' \7 U# q" W: }( V
1.将package.json改造成以下模样:
: k+ W, a+ a" \3 C
{
  "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包会失败。# t4 A# }' ]! u7 v; L
3、编码
0 |+ o% q8 L; X  _# ^       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:: x$ C- u5 v# S- V4 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。# j8 Z( t$ F  c9 ]/ b6 [; F
四、调试" K# M# ~$ B/ E" e  X6 u
       单纯的开发代码片段的话测试和调试都非常简单:; W& R  [3 |6 k% l& e
  • 首先先自定义全局的code snippet。$ \% f' s; g; D* u8 E) d8 Z
4.jpg 6 ~" g8 Q5 M* k  C; O5 A
  • 选择新建全局代码片段文件。
    0 M3 I2 v- u( ^5 K9 X- G4 ?% I
5.jpg $ H  z  H( I7 y$ c
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    , l3 O2 m) S: g( z  o! U6 l
6.jpg 0 _$ }) o) n; Y8 U
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    / ~- u" G* c. |( {
7.jpg
% b- p7 I) _* u: d       生成的代码片段如下:3 P3 P! p. b! G5 ?
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;
五、打包, L# C+ J* a" u& i- X
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。$ ]0 a( a- R' A% B
六、发布
0 j! g' N/ f% p6 p0 ?' _; c9 L# a       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
0 ^! e+ ^$ _8 \9 k' V0 g: b 8.jpg + [" k8 W" w! U) v. F6 W6 g
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~8 u& q! G' ]/ C5 b9 \
9.jpg % l; @1 N  c- E4 z
七、结语3 W( a; R+ J. C( c0 Z: u
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-25 09:41

Powered by paopaomj X3.5 © 2016-2025 sitemap

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