QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4874|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
: J/ [; E& E2 F3 K       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
) ]) t+ w: r0 [5 w% r8 ?  y& x: I4 F: ]二、环境准备- p( h& r. k) x. r9 N
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    & l2 D! b& o- |9 }7 E1 H4 f, n0 X
三、开发者账号申请
- l3 R& `% f& t2 E       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。- |/ W. z7 m0 N
1.注册并登录 Azure DevOps' n4 {; o$ U3 J- B5 Z/ A7 P8 E
2.选择或者创建一个组织(new organization)。
- X" q1 k2 @, \' Z6 h0 q3.在该组织下创建一个项目(new project)。
2 O+ ?- Y; l6 ?8 g       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
8 Y1 ~7 s$ X& x, R, |9 _' O( X 1.jpg
: v1 X9 r' `+ x/ F9 `- e3 \4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。+ F9 ?8 B% ^! E$ G
2.jpg $ s1 s8 f- {# E  A, N
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
* o, m- D- ~: d三、项目搭建
% y! o% P  \! I" p1、项目初始化' J/ M3 \, [% b8 I6 P
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。9 k5 a4 S/ b0 Z
3.jpg 8 \1 m% d% M1 ?& k2 \, S' g
2、项目改造" m) O0 e$ O9 U7 ~7 S; p
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:" g  v7 `. i9 p# M  Y4 n6 H
1.将package.json改造成以下模样:
- }. |( D7 u  t. E. Z. B) |+ E' 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包会失败。
, \# _7 R/ s7 L3、编码' U" N$ K' ^3 h; w7 u
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:( g* M3 K1 E. M* w) Z: j+ j
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。, L' J4 q0 M% O  \& d3 }
四、调试
" U2 l& l' O0 P$ g5 D& w       单纯的开发代码片段的话测试和调试都非常简单:+ `3 B! p6 f' U
  • 首先先自定义全局的code snippet。
    ( O; B+ H$ ]  _4 U9 P& Q
4.jpg
$ z5 _  x; t: l: o
  • 选择新建全局代码片段文件。% [3 H" @; I$ F0 T
5.jpg . m6 `8 |8 N7 p; ?4 N, G) Z
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。! |) ^! Y; |/ L4 j) \$ f% ]$ i. a- \/ X* Q
6.jpg 8 [5 W! _! X% Z& U; t
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    , M* F, S6 d( Z5 `  E
7.jpg 0 u; N; z5 c2 I% P. @
       生成的代码片段如下:; }# F8 E5 F% Z/ Y4 N) t& u
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;
五、打包
8 I2 K: d& F; y* ~( v       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。  B& S8 B8 R) P0 Q5 r! f$ ?
六、发布! o% h- x# U& G0 K  k
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!  V4 \0 b- F. k2 O+ x! ]; ]
8.jpg : D% S; d, m5 R/ K) P% l# q# E
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~3 @& G7 D7 \- h+ k! G( u5 D' b
9.jpg / S% D" S% Y; c' H
七、结语" m/ Z2 ]7 e3 a4 G) |
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-25 12:54

Powered by paopaomj X3.5 © 2016-2025 sitemap

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