QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4580|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
1 X& t9 A5 ]2 t3 \9 B6 ]       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
# `% x( x3 A; T. p! E+ h- }7 b二、环境准备3 i3 |/ c( L; ]+ ]
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g" V3 w6 ?& h" Z+ T0 l* B
三、开发者账号申请
3 U0 @! e! n& b2 H6 W. V       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
2 V6 W# z3 v  d4 g0 K; V; n1.注册并登录 Azure DevOps; h1 W6 @- M) r2 W
2.选择或者创建一个组织(new organization)。
0 I3 f% E3 \( c* O. ~3.在该组织下创建一个项目(new project)。! Y4 h1 o, s- ], C5 I8 @  l
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:) b  M7 q0 f* n
1.jpg 6 b" m$ W6 ~1 P4 l8 d, [
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。/ Y% @4 K) U2 |. X0 q% T
2.jpg
9 w7 j$ m* v' a: _: I) t5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
; I& d+ s1 b! p- C0 v8 R4 Q7 B三、项目搭建
7 R2 h3 F' N+ B$ ]! W1、项目初始化
( q( I1 e* _" U% j8 ]5 ~
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ) K! C7 p7 @5 B' g# }1 N- z
3.jpg
$ P5 d, ^) b" J5 M  g0 s" a2、项目改造4 b: o# N3 L" [4 X& u& G: R
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
2 u- Z- w: \% U- |1.将package.json改造成以下模样:# k% r% L9 D3 L3 F4 o9 ]' 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包会失败。
5 R$ R' g/ p2 ^) W. Z0 b3 v" E3 W3、编码
) i% |% w+ d8 M& n2 X* ]4 ^       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:" ~5 l  w) G5 \2 }% v( t3 u
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
$ z# k, Z2 [6 W( z* ?四、调试
' [- [$ |9 L4 ?( X6 z       单纯的开发代码片段的话测试和调试都非常简单:
3 _6 ^+ D/ G& k! K" I
  • 首先先自定义全局的code snippet。
    # b, E* b3 R9 g6 c$ F) z; t
4.jpg 7 ]! A5 i. A  X
  • 选择新建全局代码片段文件。
    * I# u$ q- Y! h& z7 N' Y: J$ \
5.jpg   I7 L& x6 u2 C
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。( D" }# k0 \7 s, L
6.jpg ' Y, Q/ Y5 \) f* g
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。! ^0 C" m% p8 b# \
7.jpg $ a5 o8 S, f" N  n
       生成的代码片段如下:: K$ `' y0 M  m/ i7 Y; }
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;
五、打包4 G3 N. N2 H) u2 t4 I6 f5 `
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
! N% b9 i2 s' G2 x& C六、发布
1 J# K# ~  L7 ?+ U" f       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!  ^6 l' y  M: C' V1 `# d
8.jpg
; N2 o9 p! c% i* Q( p* f6 ~       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
* c: y+ H4 X/ E6 W- R  G5 ~* @) ] 9.jpg
! R' J. E$ ?6 D% M/ |9 m七、结语
4 E0 F* {7 y" m- M6 a6 _( q6 F       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-10 13:51

Powered by paopaomj X3.5 © 2016-2025 sitemap

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