QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5084|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言2 q0 @% C! p! q
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。7 B- |3 [! d2 M" C5 P
二、环境准备$ Z2 f7 S/ q& U; }! x
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    ( Y% b: w/ y4 S5 }% A% u2 f
三、开发者账号申请. _7 ]! e! E; {* a! Q0 v: y2 R
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
7 g8 R* b5 d$ H1.注册并登录 Azure DevOps
; r% L" h) V- e4 p2.选择或者创建一个组织(new organization)。
. K$ h9 m) U8 z3 a& P3.在该组织下创建一个项目(new project)。: P5 D7 N4 R8 q/ H: O
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
5 C+ z" }: ?% w. h. M, S6 Z 1.jpg
# `* d0 U2 A& F' I4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。/ i0 g& E$ B8 L1 v
2.jpg $ ~7 j0 J1 V% o  _5 p8 H
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。+ ~' K% Q2 D9 `6 O
三、项目搭建2 b. t, Y1 `0 h% \" [1 ^
1、项目初始化
0 f. g/ Q9 t+ d  H4 W2 L8 W+ Z2 z
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    0 H  ~$ K9 X  A# [% [4 W7 S5 p
3.jpg
. Q& u) N% O1 }/ U) ?( H% M2、项目改造
& {3 y! A3 `$ a5 Q! C       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:7 Y8 ~! H& a1 n2 u
1.将package.json改造成以下模样:
$ e+ F- Y& R) ^, K
{
  "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包会失败。6 r& I! B4 \( Y0 x, x
3、编码
  G" S, s% h: k$ k6 y       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
! u( q4 @) m7 c2 g& M
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
$ p! ?6 d' o1 ~四、调试# K* V+ V6 s/ j" C" h
       单纯的开发代码片段的话测试和调试都非常简单:
* H& n( `$ ]- d( K! E. o7 R; {& n
  • 首先先自定义全局的code snippet。
    7 E" |8 y9 Y" d7 A3 r- L. m( e
4.jpg " a' N- a# \4 Q: v! i* e3 N3 M" z
  • 选择新建全局代码片段文件。
    ; _4 I* e5 u) X/ l" d
5.jpg   C7 w  [, T. Q" p4 N
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。7 n' H# v; N8 R, [4 V% m% V
6.jpg
; e( `. H4 _& T8 T; w
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    8 h3 G" ~9 O& ^" }, F, v$ d
7.jpg 6 B' s, l1 H( `1 [, `! m* K
       生成的代码片段如下:0 D: d( q/ B" V8 k
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;
五、打包$ Z3 N: \: Q0 i/ u, }* X: E
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
+ g, R1 C9 i$ p/ a六、发布
. R; O, e0 h+ M' P       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!# X7 k4 Y0 R/ J/ Y
8.jpg ( c; a( L$ y& \; f/ `
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~$ f6 k2 U1 V$ g4 N8 p/ g
9.jpg
: u" \% x  M  l; w: S5 @8 n( f七、结语( ~9 M! a# l/ p' D, f7 {* B; M
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-15 18:10

Powered by paopaomj X3.5 © 2016-2025 sitemap

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