QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4547|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言1 S% @0 |7 K* h) {0 g& E3 d: f
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。8 R3 v3 g. C: ?1 ~2 p! R
二、环境准备& r1 W8 `$ z: l' x
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    . `3 B! `2 s7 m& {5 p
三、开发者账号申请  |2 V! Q+ N. V
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
5 \. P. Q2 [9 @: ?1.注册并登录 Azure DevOps6 q! |3 C% Z8 U" }: V/ W
2.选择或者创建一个组织(new organization)。" G' r  U6 P4 D4 k' `5 P8 }
3.在该组织下创建一个项目(new project)。- w2 j4 E1 ~& z' s4 j: ^3 W  s1 P- q
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
9 i$ ]( _1 ]1 H( G( b4 F 1.jpg ! z: A# N5 G6 U9 e' m* a' g1 L; Q9 x7 F
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
* u; J! Q* k8 t1 S( z% H0 P& o 2.jpg
8 Y: K% L0 ?% o6 d7 a5 b& k  R) ^5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。- J( a, @# \# w, C/ a# F8 k/ T4 W
三、项目搭建1 ]! R. u  u" S. D$ }" o8 U
1、项目初始化
5 g/ A( w* N* a7 ^& Z4 s
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。  q/ Q% e0 m1 k; F( Z. z0 \
3.jpg
1 A1 [  \+ @3 k7 ^) q4 r2、项目改造7 L- J3 p# d+ ^  c) ]
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:. n* x* g' `6 s/ z9 }5 T* ]+ g0 y
1.将package.json改造成以下模样:
$ _0 Y+ i* o/ i) Y% x" @
{
  "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包会失败。6 x3 Y: @0 _+ z0 y4 g
3、编码
8 e" Q- D( ^0 l       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:* a, l* z0 X8 |1 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。9 u2 R: L  G! P4 b( {
四、调试; Z4 ~. ~; }. m) A
       单纯的开发代码片段的话测试和调试都非常简单:9 i# V% a' I9 G
  • 首先先自定义全局的code snippet。! C7 d) s% J5 Z$ ]
4.jpg   d/ G+ u2 c- v; F
  • 选择新建全局代码片段文件。
    * g6 m" f5 R+ G3 c; [8 |1 K
5.jpg ( n! }2 R2 s% S$ K* f
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。5 U2 ]3 `# o' @0 s* g
6.jpg & ^: B4 p, }: w; {2 I/ Y0 q$ g& x. I
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    5 i7 I. @+ u  W3 Z" N$ Z4 V, C/ m
7.jpg   k9 }5 U) E5 n0 i% x; P% T
       生成的代码片段如下:# J* X8 j/ P0 R. a! r/ \" 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;
五、打包
1 G9 T% k% X+ Z' W       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
3 R) Q8 g6 D6 D, z- v六、发布( C1 o% G* I+ s- F
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
& G( K$ W( P; r7 N( M 8.jpg
6 B+ V9 w1 g0 L2 {$ i       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~  }+ s5 t. P* ]/ m
9.jpg 9 `) E0 p8 k' W# a& P, O! x
七、结语
6 \! M* O. p+ J- a" w8 E       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-6 10:50

Powered by paopaomj X3.5 © 2016-2025 sitemap

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