QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4586|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言" W) u) X0 o  f1 ]- ]2 r/ P- u
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。0 \7 x" m. o8 g+ {  c4 e
二、环境准备
7 y* W( _# d' l. z  G
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g. c0 r6 X$ x% K7 R0 r% }% u
三、开发者账号申请) x  h  E. X6 h/ T
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。& h7 g  ~! N. `& o
1.注册并登录 Azure DevOps( s  I; q# z8 [8 y
2.选择或者创建一个组织(new organization)。
  l9 b* h. c6 ?' n- N$ G, ~+ p, |3.在该组织下创建一个项目(new project)。6 b9 Z: S4 `: N/ \6 ]8 }
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
& Q% W  j: F7 {- M4 }, H 1.jpg
# x) ^: t+ s- e7 {, z  G4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
* q, b+ P1 s1 J5 R! K" z- Z8 s 2.jpg
- f! H6 o, s0 G! T* V5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。/ d' r; f* O2 U0 b+ i6 T7 ?; O
三、项目搭建
+ c' \$ \3 {  j. [1、项目初始化6 C! O7 w, L. F9 k1 D( b, Z
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ' b' g, j4 p6 j7 V
3.jpg 0 ~. J( z% Y" `9 K6 U
2、项目改造- x, V7 f" ~. f4 R3 b& P0 c4 G" I; z
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:; M0 K8 y( o% q! o! T+ N) g
1.将package.json改造成以下模样:
( a* n  p* j. K. H/ K7 b7 X; a* u$ j! Z
{
  "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包会失败。$ I- I8 D1 \' Z" F
3、编码
+ Y& N1 x) V7 G3 [       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
, t# h+ U! _% M  g
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。7 h9 L2 M5 `/ ~8 ~$ T0 {2 @% }6 p
四、调试+ e* u$ d0 x. C1 K  S+ j
       单纯的开发代码片段的话测试和调试都非常简单:
. y/ o2 l1 ~. ?5 {
  • 首先先自定义全局的code snippet。
    4 W0 {7 K+ m( D- q* X. P
4.jpg
( E( d* H) S1 A! M' e' ~
  • 选择新建全局代码片段文件。
    , G. u0 e+ y3 d7 p$ N* g# N  h
5.jpg 8 j/ ~( ~1 C# W" ^* L8 E: M" k
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    - v  J* _) g: R
6.jpg : L: h6 {: h7 a1 @1 ]
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    8 r' i2 h6 U* O" V, \( Z, b& g
7.jpg % a" z: M, U: W; ]- g
       生成的代码片段如下:5 F! x* K8 ?( Q* i* B2 @
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;
五、打包) F6 M6 v1 H4 @7 K
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。* }3 m5 N( t! u* [
六、发布. V1 g1 b6 s0 \- C! u6 e
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
4 R0 |1 B# s4 H0 S+ U* O) W 8.jpg
! V  i" u4 b0 N* _       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
! h6 M- G) P0 Q! T 9.jpg ( d; K5 _- W1 u6 E3 p2 \
七、结语- n% `6 w- H  V. E
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-12 12:05

Powered by paopaomj X3.5 © 2016-2025 sitemap

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