QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4960|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
( A6 c3 o* h* A, K! y$ G$ O7 r$ q       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。) r" k4 i* D3 m6 y7 W
二、环境准备
) }* p6 [* Y. H6 Y4 S' Q
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    % `3 `: v) U! i6 J  x$ R8 \8 |7 F
三、开发者账号申请; Y+ H( s& j: r0 H" S
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
% m* ?8 l! r+ v4 C8 m5 e& r/ R1.注册并登录 Azure DevOps/ U5 M9 f( }+ q- M. R7 k3 ]
2.选择或者创建一个组织(new organization)。( ~# h1 B, d* h+ l, d
3.在该组织下创建一个项目(new project)。+ Q% W8 M6 l% }1 p
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:0 o( n( n8 C" z. [! R
1.jpg
8 u$ |( |! Y( Q& _, U6 @' m4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。9 l. G) Q  i; f2 J7 m
2.jpg 9 w! c8 U! f9 w5 R. O" S
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
; ?" i# a; W4 n/ e, ~# ?三、项目搭建
* ], ?' ~, U' F5 @  B+ m& r* l1、项目初始化
% `" B' O* x" G: E: z8 k( r
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ' ^3 v, Y, `" ]* Z( R
3.jpg
" a9 v3 H6 X8 p  o( |2、项目改造
7 u' C$ N. F$ L, N       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:, @. S& y% Q& I; B9 d7 T+ I
1.将package.json改造成以下模样:1 z8 r# A, V' W; w
{
  "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包会失败。
. C  n0 S" o: S4 M8 @& s! o. Q3、编码: J# h/ f6 a4 H* k' H( a
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:* @. P( d! m, r
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。0 ?# R/ h, K7 g
四、调试
3 H* s  a3 q# C7 {2 O; W$ F* C       单纯的开发代码片段的话测试和调试都非常简单:) {$ R  N/ Y1 q* g4 s# q- \2 i
  • 首先先自定义全局的code snippet。
    $ Z% G+ H7 F4 c) J' z
4.jpg
, a, Q9 Z( p' Q, h7 s
  • 选择新建全局代码片段文件。
    & ~* ^" I1 ~; L9 G* c/ I! j
5.jpg
& q3 S! X  Z/ l9 I9 Y3 O; U" M0 Q
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。* w, k0 \* E! U6 ^4 f
6.jpg ( N9 h9 l" C8 [% `  L: S$ p
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。2 {! O/ p7 s! j2 J7 ]9 _6 E
7.jpg - F. X6 D, ^; m0 F
       生成的代码片段如下:
7 @" i& _* v6 N  o6 x+ \7 r. C5 R$ O
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;
五、打包
* ^6 [- O# j# V" Q( Z) r' s, h7 F' _6 @       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。1 C# r% x8 P' ~! W. V
六、发布
; F5 D0 b4 e. C, |" S       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
& s; `4 \6 E; K- t 8.jpg 6 U5 h, d( P# U8 p- ]: U
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
/ e, \( F6 E! u2 G 9.jpg 9 ?' g# D- x" |& @0 l8 K* A8 f. t
七、结语* S3 x5 R  _+ [; o( m) R+ F+ `
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-3 03:45

Powered by paopaomj X3.5 © 2016-2025 sitemap

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