QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4569|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
7 H0 W/ X4 q  o, d1 x0 i2 z       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。( G  y3 ~  z/ i; b- h4 Y
二、环境准备
: u! l' e& Y. {" `6 j8 F4 I, a
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    . Z5 Y, H: r' s4 `
三、开发者账号申请! q: L$ t. H2 _! k
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
- R. h, K4 P. p. A2 K1.注册并登录 Azure DevOps
! ]- S' A' a+ n) x! B; z2.选择或者创建一个组织(new organization)。& [/ ~+ r$ n* ?% N6 D9 P( k* h
3.在该组织下创建一个项目(new project)。6 i: O0 O5 ^& s" f5 D5 O# M
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
/ {% s2 F9 `+ {, D( C 1.jpg
2 b5 w4 a9 c6 e3 @& m8 x. o# l4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
0 B5 H/ o1 |2 r+ j: C9 O& L 2.jpg " `' d1 v0 Z5 P; ?$ R7 x$ v
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。5 g& _4 S; W, \
三、项目搭建
8 U8 t; t8 |, f6 X1、项目初始化
$ Z. g( b- V: Y9 O! P8 K8 _9 j( l+ i
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    + l" i' I# e; D1 U
3.jpg
* s' j5 o6 z; u6 K0 w2 y+ W2、项目改造9 x/ H: P3 b4 F1 o; H2 H* i
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:, H+ @( i" m* O* ~1 Q
1.将package.json改造成以下模样:
2 y% B' v1 {4 y% K( l
{
  "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包会失败。
  K& C$ l- a' S6 d) |! q0 {! G3、编码
% Z0 J; k0 {5 M+ D3 S; D1 G$ t       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
9 B2 E7 B! V1 `* T
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
" W1 {. K2 }' X四、调试7 t7 x! C4 T: ~( m
       单纯的开发代码片段的话测试和调试都非常简单:
" o  ~2 t0 T5 ~' U' i( V; |- M
  • 首先先自定义全局的code snippet。5 ?4 b) f' Z0 e
4.jpg ( d7 x2 s# d8 q- y5 C
  • 选择新建全局代码片段文件。
    7 o$ z  C2 }$ g( C: F
5.jpg
1 M. W9 C( f! \0 f/ w& P
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。% G7 [) Z. A7 Q0 O% a5 ~8 ^; V  E3 A
6.jpg . C# W9 O0 j1 S) L
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。  Y; R+ ~+ w: K8 i% l
7.jpg 4 Y4 a3 K& E* H7 ^$ M) _* \
       生成的代码片段如下:3 Q/ X8 i- v: H; w3 y1 V3 L
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;
五、打包
# K4 P0 P$ P: D7 n+ R/ k8 W8 ^% Q       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。. ^5 p, P0 j# O+ J8 j% N) j& J
六、发布
  ]' J* k( V  R4 |; ~       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!8 J& f+ L0 E# P1 j, g  W! [- G" D
8.jpg
8 U4 C) n4 t( q: @       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~! a4 L5 q" d4 {8 Q/ z
9.jpg
. n' o1 C  T4 {( J+ {) Q' }七、结语
: u4 i2 z9 K2 p. E( c       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-9 02:40

Powered by paopaomj X3.5 © 2016-2025 sitemap

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