QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4593|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言6 V% Y1 `- `. z6 d; `
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。# c+ M! Q" F* C& _+ \1 b5 B* f9 A
二、环境准备
# t6 E% B0 k' B8 X( Z6 Y9 ]; I2 n
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    + A5 p: t4 X3 F1 l' E6 ~
三、开发者账号申请
) U8 X& y/ B0 ~% y2 U/ T; V8 m       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
+ k% n7 }, D' `) N' J6 u% o2 G1.注册并登录 Azure DevOps
7 ^1 v. D- k* a! B0 u# o% ^2.选择或者创建一个组织(new organization)。
+ G/ Y& g/ h0 R0 r6 @) `1 \3.在该组织下创建一个项目(new project)。+ P) X3 M! v+ u" o
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
6 \! b, |% N% B  t 1.jpg , m9 Y' l. D! ?" X4 i8 B5 U
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
. Y. N1 l; \! X2 u/ { 2.jpg ; _) Y, c5 D! X& E2 K( ?1 z: k
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。, g5 @# u8 s  n& X2 G% K" A) h
三、项目搭建+ E- W: Q" P% v3 h4 l$ M0 m
1、项目初始化
, F. j$ u0 J! J9 }9 G2 \8 Z
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    6 R6 @4 S0 o+ j$ ?' K/ Q4 G( u5 h
3.jpg
( u. o( O& x% u1 d$ Y$ o- R2、项目改造) l3 A" [6 d( S* d- |% w2 f
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:0 J& ^3 o! J' e4 e2 V
1.将package.json改造成以下模样:0 c$ G9 ]) y. W  E: q& i, P- I# 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包会失败。
9 X/ p1 Y9 C8 y/ ?# b, g4 |! N( i3、编码
( Y# b7 V2 O8 b* ?+ [3 O       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:% N$ e$ m  v3 Q
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。- u, q' Y7 r) h" e, `9 @6 K
四、调试8 C" B. e0 W- R% \9 P: P2 E
       单纯的开发代码片段的话测试和调试都非常简单:3 E" r+ {1 w5 X$ s6 Z  w+ @
  • 首先先自定义全局的code snippet。0 ^3 \, c" f  y$ N! U1 O4 a/ N
4.jpg
5 U2 M. Y/ ?+ l3 r- ^) y! X8 R- S" U
  • 选择新建全局代码片段文件。
    * L) x, C# |6 F8 g
5.jpg
6 Y; [$ s4 S6 ?$ e, U7 [
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    8 g; ~: I0 H3 V2 F& i. }
6.jpg
, u) |5 h& G5 f" Q
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    : k: ^' ?) X9 P! f1 O3 l2 f2 O
7.jpg
& J( I% X  }0 C& ]* c       生成的代码片段如下:( I: T5 j, e5 U$ K8 ~5 e
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;
五、打包  Z8 v/ B: a6 S: T4 l5 {" F* {4 H
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
0 m6 i' b% o& p- ?4 x+ G; W# K3 K六、发布% v; v- ~  C, O' |
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!3 y/ x( D& x4 q, W
8.jpg
; I2 G( |/ d* L6 m, t       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~/ C4 g, @& y! V7 s( o0 U
9.jpg 2 h7 r+ B( ]1 W6 }
七、结语  o. u; \5 L6 M8 x. F8 l
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-13 20:49

Powered by paopaomj X3.5 © 2016-2025 sitemap

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