QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 2507|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

积分成就    金币 : 2859
   泡泡 : 1516
   精华 : 6
   在线时间 : 1320 小时
   最后登录 : 2025-6-15

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言7 h; u+ T  ?8 X; |) ?( ^8 K
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
- a& G, f. L: l4 j; E8 y二、环境准备
- E" w2 g8 Y$ u2 D' P6 E8 I  W
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    , @( r$ A/ M) ~/ r$ `
三、开发者账号申请
# P8 P; S; j8 S/ o9 h       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
5 Y6 e1 Q/ o) |1.注册并登录 Azure DevOps  i" K+ M/ Y* g# L8 K
2.选择或者创建一个组织(new organization)。6 F4 m1 X2 K; b
3.在该组织下创建一个项目(new project)。
% h) Y3 B  [5 @6 q7 l6 [/ B. Y       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
9 k6 H  T# M' s" E0 S/ |  D 1.jpg # Z. u5 c4 s4 e9 z- e6 N3 Q
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
7 c! r& b% [  B( a+ w* F6 o 2.jpg + U2 P& k# V) m
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。$ {2 W  m3 ^3 i! V: _& N
三、项目搭建6 R6 A% e, N$ W' Y5 S& C' q
1、项目初始化. z+ e0 W4 w; H! m2 V0 R
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。$ b, F7 B; @) n, U8 C
3.jpg * T* {( G& q3 j! Q+ V) Y: O- K- ~
2、项目改造8 R2 {! Z6 b6 t6 r2 f( j! k
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:) L4 t. s, m; O$ ^  E& @) h
1.将package.json改造成以下模样:
! b' f6 N2 z4 N7 p/ f
{
  "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包会失败。# M7 w; E; J1 B: L) ?/ _
3、编码  E( b' ?  L' @
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:4 ~; k' M6 A! z8 W, v& Y) s# O
{
  "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 \4 x4 U) S5 Y) [
四、调试
0 r7 ]7 |9 ]1 E' Y3 B       单纯的开发代码片段的话测试和调试都非常简单:
0 y# D3 Y1 |3 d
  • 首先先自定义全局的code snippet。
    / p0 G" [5 \- M
4.jpg 0 F5 T$ ], d* d8 e. p
  • 选择新建全局代码片段文件。* F% f/ u+ F4 m) y1 X% K1 e1 p
5.jpg , h1 v( y$ F1 W/ y0 Z2 K* E: J! I
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。0 z! u# D( U+ v! U
6.jpg $ K! M3 R: P9 G; _# \
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    ) C4 _9 g6 o2 Z6 x/ Q, z0 J5 [
7.jpg " u7 H1 d0 E  p& ~5 G
       生成的代码片段如下:
8 Q8 N; h5 V7 D9 j' Q
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;
五、打包% K7 c3 k- N8 |3 m* |
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。4 ]; E3 i7 c: C
六、发布
. J0 x& W8 u. A5 G$ b( \/ O       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!5 u. [1 \3 x3 c; o: ]: g
8.jpg
7 t; d  Q% V) i       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
. A: @1 [  M! g$ F" D( i) N 9.jpg - n: w: \" `  r
七、结语, s( E; S7 x8 I/ @4 l
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2025-6-17 14:01

Powered by paopaomj X3.5 © 2016-2025 sitemap

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