QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4930|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
% R. M/ P7 N/ v3 |       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
9 O. |6 @! ~2 b; R5 {8 ]1 ]! \3 a二、环境准备9 X+ B# S1 {6 C+ U3 B% Y
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    4 W& X* q4 h  v
三、开发者账号申请
. ~7 q$ ~6 U5 F- P: T! q       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。5 U* z) v& N* n2 N
1.注册并登录 Azure DevOps
9 R9 P# n( K6 y5 Z7 `2.选择或者创建一个组织(new organization)。
! d  h6 f% z% J" n3.在该组织下创建一个项目(new project)。
/ l: D% n" V. g( u: X) P1 D       以上三步都是为了获取开发者(publisher)的token,获取token如下图:! A, K% E  Y0 u, i9 {7 ]) G2 J
1.jpg
. n5 i1 ?) ]5 l3 w4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
. T  t5 b6 E2 D5 v6 G# e, c! R 2.jpg ) }5 B& f, g3 \/ G' @% j9 ]8 M9 Q
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。/ Z1 J* D$ R3 L
三、项目搭建
7 [# P1 C6 o; J+ u- C- O6 I( A1、项目初始化
8 i5 v, _* W/ H/ F, V; R4 e$ q
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。4 p! w( |* t3 \, i
3.jpg " Y# V* O. w& y* @. h+ f
2、项目改造
  Y; [  g, P+ `" H4 V       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
# o2 b& n& ~. `- W  U6 _  M& w, u1.将package.json改造成以下模样:9 c8 _9 T' w0 I8 J( H$ Q3 c2 Y
{
  "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包会失败。
! S7 r2 _- ^; M' I/ K3、编码7 b, D/ @7 i3 o1 o0 s8 S
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
% C* L/ l" {- p- g: 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。( `6 D- U3 }1 c$ i; |
四、调试
5 l+ C8 T) o4 d$ q( N       单纯的开发代码片段的话测试和调试都非常简单:
5 t! [; ]4 L& `# N# f2 f* A$ ~
  • 首先先自定义全局的code snippet。
    # L( ^/ U* F% b. i* S& ?4 @
4.jpg 5 p! T$ s% R9 E- w$ J/ ~
  • 选择新建全局代码片段文件。& R3 a0 v- k9 `) \- a6 B0 c
5.jpg ! V, f6 n8 {# L$ P0 C# }! [% a
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。/ g1 R) M* F: d# Q. a
6.jpg 3 ]0 d! ~& S, T* V
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。5 @0 k+ T7 v* _
7.jpg
" a3 F0 _) B# ?! b0 S       生成的代码片段如下:
" V7 G1 j! Y$ Z' W, ]+ u. w
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;
五、打包, L- D+ x7 P3 |9 y& n0 n
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。/ s) P" g. m5 J% ^3 A
六、发布8 S+ K, ?6 ?4 W0 H- Q6 h! I0 X
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
2 s  B2 o' U1 ~  ^- h 8.jpg " }. ?8 Q, A- f
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~/ x% z& j  [1 b/ f' F
9.jpg * A) z! g/ h1 k- G- u- ]6 n5 G
七、结语
8 g! F. C# `: o; Q" k, K       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-30 12:24

Powered by paopaomj X3.5 © 2016-2025 sitemap

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