QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5074|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言2 v, X* M+ g' U1 N+ I
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
% }/ P8 H$ ^' F9 k7 m" A二、环境准备
$ S4 o. k6 t+ W* }8 j( {. ]
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    " j% X% _! P9 T/ n1 H/ w/ d' o
三、开发者账号申请
' X- i9 j9 Y8 M. N5 a       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
3 A* H: ^, P5 n1.注册并登录 Azure DevOps9 w3 L3 A+ P, ~$ }
2.选择或者创建一个组织(new organization)。
$ j9 @* k0 I/ B+ ~# G7 x' k3.在该组织下创建一个项目(new project)。9 I) Y5 n' n6 D  F7 o- a7 o. N% i
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
# I0 U/ ?2 }% k5 }$ m 1.jpg
) f: R1 \; C+ o0 H" U; }4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
* F, ]0 }8 K3 m" d. A3 L 2.jpg
8 B# Q+ k3 p( p8 h) e5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
1 ^; U! P9 Z: \- r% I0 }" a& w- B  B三、项目搭建
6 f! `2 n0 M- a1、项目初始化% G/ s) J' E6 G
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    $ h% {7 N$ {' h3 K) f) j
3.jpg % h1 s7 I% b: e/ I3 _/ R
2、项目改造: F0 S7 U# M: w4 P( B" h" q
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:- X* O/ F4 z( `. ?! j4 e
1.将package.json改造成以下模样:3 L! P0 c5 ]& B) V/ i
{
  "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包会失败。
- c% i" I; D7 `- V. E9 Z! P% n3 C7 a2 u3、编码8 @4 N9 G- K+ I: b, r
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:8 a# Y0 [2 E, V. C. D
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。& f: y/ Z6 v$ ]# R
四、调试& ?" [2 F' ?1 m5 T$ ]6 I/ q
       单纯的开发代码片段的话测试和调试都非常简单:. I: k  u2 I1 o/ G! R+ v4 P$ Y
  • 首先先自定义全局的code snippet。0 G+ `$ K- e# d, p3 b
4.jpg
# J2 S, ~( R8 i" V
  • 选择新建全局代码片段文件。5 x$ ^) O# f0 r
5.jpg
8 t8 o" |, \1 |* v$ f# I" ~
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    . Y* U0 I0 J( s  y) p6 x
6.jpg
$ S9 F3 ^6 J# ~, Y; @( ^
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。4 h% ?% B" J! t
7.jpg
  q9 m' b2 t* a1 x0 f* Z: O! L$ E       生成的代码片段如下:- i  R7 R1 k4 q% h2 K0 [
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;
五、打包
7 g; z  A5 B2 J& E; q% Y0 R3 i- L       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
# B; w% S: i$ @; y) w$ Y六、发布0 d$ W; y/ V5 x5 u' T. U
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
5 L/ P2 y% Q  u  I2 X6 O2 k 8.jpg
6 \7 G) Z: y' w8 _6 s       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
# ^9 f0 p: w, {% a: S5 d7 D# \ 9.jpg 7 t8 F8 B% B4 P! H# X
七、结语  x1 S7 t1 n4 B
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-14 23:37

Powered by paopaomj X3.5 © 2016-2025 sitemap

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