QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4772|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
6 @) _& H2 n3 P" A" ]       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
1 x5 o* x- Z' B. _, t4 r二、环境准备* b  ]  }9 \8 @' @! J
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    & k2 t0 p( w3 }2 O1 b. M( E4 a
三、开发者账号申请# w+ v$ a; F5 i% }1 v2 M5 q
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
+ e' O* E* I- E* _1 v' ~. W0 K1.注册并登录 Azure DevOps
' G% l" y* ]) k) D7 e8 P2.选择或者创建一个组织(new organization)。; k" C! ^9 L/ j
3.在该组织下创建一个项目(new project)。
. b4 z0 u2 \+ L! {8 F       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
: h- u* X' @% F2 i1 u& y6 ?% L 1.jpg % q1 I7 T# K) _9 \
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。5 d3 K: g9 {1 J4 u- D0 x2 K+ a
2.jpg
1 y1 }  r3 R( l5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。. c6 Z: S. w" E* q
三、项目搭建
. T0 p9 q4 r% K4 |" ^  o3 |- l1、项目初始化
9 s* Y' G7 x) B. F, V7 `
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。' c. i" ?8 G% D- W, A7 ^
3.jpg
/ x7 k* k6 _* P, Y2、项目改造3 H+ Z. d9 {; w* b- m
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:. z2 u# F- L3 j- M0 J
1.将package.json改造成以下模样:/ F. |' ]& ~6 v9 |8 [( v$ g: u) t
{
  "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包会失败。
2 U: l/ p! o$ u2 x+ Q  L) s3、编码
" X, k0 O0 }  H       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
! {7 v+ A' y' Z: 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。  w: f4 i$ S+ _5 h" y. ?: }* \: I
四、调试+ S7 l3 i3 P7 p& h6 L" G* o- i7 D
       单纯的开发代码片段的话测试和调试都非常简单:
. {& h3 B5 o) X
  • 首先先自定义全局的code snippet。
    ! c+ m" c* E* B7 I4 [
4.jpg : F, j, O7 e" @$ {  ^6 l
  • 选择新建全局代码片段文件。; j; `# i7 g! k1 N: h4 m
5.jpg 9 z" p+ M- o+ w3 b+ ~
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    $ I  |6 \( K9 [! d$ I) p7 f
6.jpg
" G  F; k" i) c1 p5 s" U, T4 @% C
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    4 E, O  }* X+ H  n# P% R$ n% N
7.jpg
: q# S( G3 e5 w5 P+ G0 g/ z) B# l! d       生成的代码片段如下:; ?* J* E8 r- E; ~% x1 r
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;
五、打包' T7 g3 I6 `6 G3 S
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。' N! K5 Y8 U6 `1 d& t* A! h9 R9 X) Z
六、发布
6 Z' v9 {  P) I- ]" J       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
+ n; x' n9 R+ g% o- E2 b% | 8.jpg
5 G& p  y- N; N       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
1 R% o! ?! Z( {$ N( S 9.jpg - z; k0 X1 V& U% R: p4 n7 n
七、结语+ \; `& }7 C" ^& Y
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-13 23:10

Powered by paopaomj X3.5 © 2016-2025 sitemap

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