QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4487|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
+ c7 I# O! L& F+ C2 N! ]       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。1 @! z) N# d. i+ s% v. |1 J4 }
二、环境准备
* Z9 w& @2 c* X( O
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g# F& `7 D5 C. ]3 t. @) w
三、开发者账号申请) Y, L- r9 U% y1 d5 M
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。5 p5 ~4 H' J4 P* ?( N6 e: ]
1.注册并登录 Azure DevOps+ N! A2 X1 u/ m2 z4 I* a+ Q
2.选择或者创建一个组织(new organization)。
. G9 U0 p, @" K, H  W; v: O" l- M3.在该组织下创建一个项目(new project)。( T+ t8 r; }2 _6 E5 ?1 _6 l
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
1 r0 I6 o+ O* p' }& \. s/ y 1.jpg 0 m. q/ g2 O  d# A' ]! f, b
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
* r$ \; \" W3 H8 o- @ 2.jpg . C  ^' P7 x0 j/ X/ |
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。& [/ E* e7 j5 X% X$ `
三、项目搭建5 e$ z5 o& B' c$ E% w
1、项目初始化
, Z! ~) D$ g0 I! v+ c
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    # h* H/ [1 ^! F0 W7 D) z8 w
3.jpg
6 ?* g9 t. j0 K* I) g# q2、项目改造
6 |: D) T/ Z+ G! A5 u! e, y       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
) }( H, V& Q7 q1.将package.json改造成以下模样:, J/ W  p& @8 |( ~
{
  "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包会失败。
! D: a- I/ h! p4 d5 H* ?  C3、编码
6 L, i) Z1 m7 \       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:8 i+ p7 `* v0 J! k
{
  "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) F4 c6 Q4 J5 {" c
四、调试" x4 R* y$ {6 z+ u" [6 w
       单纯的开发代码片段的话测试和调试都非常简单:
+ B* Y% V8 X+ C7 G
  • 首先先自定义全局的code snippet。
    ) b& r% K6 c6 m& d" S
4.jpg 2 Q0 @$ B% Q: n' p
  • 选择新建全局代码片段文件。2 H, V# C. n5 u" A1 d- c8 N6 Q
5.jpg ' f" }$ L  ]8 @0 U) A; t6 R
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。; A4 u& M5 s% r3 j
6.jpg 2 C# I- B! T, _4 p
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。. k1 M. \2 u3 m1 @- x; Z
7.jpg 1 i- ]6 d3 H# y4 Y! d) Z$ D
       生成的代码片段如下:
5 ]) L+ h* S0 W: [: d# _) q6 `
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;
五、打包
9 B/ h8 s) f- W/ n6 f) h7 A       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。4 D9 A* u' v" r* b6 V% D% _, B0 R" {
六、发布
" f& d9 u. r0 j, S' D, @       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!5 P) ?1 R8 J6 c7 n  v
8.jpg
, L- D9 Q- Q3 \. E, a) m! }       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~9 p% y+ ?* M( r3 b
9.jpg / j# z) Z' k/ }+ h% N
七、结语. R# b7 i4 X% M, E  @$ R+ R
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-4-19 09:54

Powered by paopaomj X3.5 © 2016-2025 sitemap

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