QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5149|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言" E7 b) A9 V& B+ D) \6 m/ @
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
/ l1 L3 c( m7 U& q- Q, \* c, N& D二、环境准备
  ]! Z9 F# L1 W' I. b; b
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    & j- ?) s" ~7 r' A$ n! m+ D
三、开发者账号申请
! E2 {7 y( N* Q6 `       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
" q2 e6 @8 Y) [) y% n8 h, V1.注册并登录 Azure DevOps
0 c$ Z# b' y( I! M2.选择或者创建一个组织(new organization)。8 x* ~" R+ ]8 s  @
3.在该组织下创建一个项目(new project)。& o! [$ s2 G5 d% \+ {
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
) Y' e5 \6 n+ h% J0 H 1.jpg 1 C6 V7 o& O! w( J" _) A
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。  x4 ?( u+ q6 l+ h) R; g: Q/ M
2.jpg
$ h* T) v5 S6 e5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。5 U+ E& p4 r/ N
三、项目搭建1 p7 q3 J: c7 Z5 ]. L: r7 S
1、项目初始化# U) ^7 |( i7 {( y& m+ H6 O
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。; j$ |: ~1 I, S7 l
3.jpg : k, A% q) B" m& O
2、项目改造
2 ~' z: r! w: d* i1 w       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
! c5 I, [4 M9 d( A$ J7 l' u1.将package.json改造成以下模样:
6 H6 _3 x7 ^* g) Z9 N
{
  "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包会失败。
$ i- F: {) D/ ^5 @4 h6 e4 t" O# s" V3、编码% t+ A' s, {% t; T3 P6 r' S
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:% h6 X& B2 [/ Q4 w! q
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。1 u# S1 B* k/ L. T8 e
四、调试
! c3 i7 Y% d- d! ]0 t       单纯的开发代码片段的话测试和调试都非常简单:5 Z. t9 d% v% \4 H/ U5 r5 M
  • 首先先自定义全局的code snippet。7 p1 \6 H5 p1 s- l* P2 F. ?5 E
4.jpg
4 @# m9 ~, F* F8 S6 k4 U2 W
  • 选择新建全局代码片段文件。
    % s+ F; ?6 a3 U, ~% D7 G
5.jpg
4 k/ w* \; ?3 M$ K
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    + X6 v" Q/ `' d! C
6.jpg 6 `8 |8 g! W1 L; s
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    & E5 o/ h1 Q# Z
7.jpg ' I) \' q9 b0 J' n8 I' C( A
       生成的代码片段如下:+ T$ R/ `2 L+ p. h7 A" l# _6 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;
五、打包
8 b- C- I; n% u, z- t9 N       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
& h1 l& _; g4 w六、发布
( |3 V0 @* A' n3 J; f       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!2 Z3 X* [. L/ R4 @, ^5 i! H+ |
8.jpg
% ]; y' Q4 Y9 B/ J1 s: D# |       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
; ]; k+ P: ?3 j% _ 9.jpg
/ B+ W* [) y# ~. ~4 f' B七、结语
7 K7 y# {& ~' \$ S$ z* q6 F       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-25 22:01

Powered by paopaomj X3.5 © 2016-2025 sitemap

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