QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4654|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
- r! {$ _1 {- u5 N1 l& q8 n1 ?       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。4 I( L, [& W+ K- ~4 I0 }- ]: U
二、环境准备
3 b% `9 G  g, }& [/ n1 R
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    / Y8 `% A3 Y0 V8 Z5 G# }9 a% @
三、开发者账号申请7 ^6 ~( A) W# Y/ h/ i% p
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。5 m: x/ M% B  o8 ~$ Q. F7 R; m- E5 Q
1.注册并登录 Azure DevOps) ?. M* A6 w4 ^" Z
2.选择或者创建一个组织(new organization)。- B  r% A3 D! c8 f1 u0 Y  V8 w
3.在该组织下创建一个项目(new project)。5 r+ ?# z- G- Y: [- V
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
, B3 M9 q, I0 k( `- ]: Z+ v! ^ 1.jpg
) h. r0 |( k( ^: g4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
0 n( t& Q0 J+ ~9 X+ i 2.jpg 4 F3 O, X" M6 t+ {
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。" c) ]% H! c3 Q' o# Y* m3 o
三、项目搭建  Q" w" B7 a" o& ]1 i% s
1、项目初始化& b, U0 G3 s% M+ A5 p2 c
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    , ~; q0 j2 C8 p9 V2 n( h
3.jpg & ^; U9 W- h% F0 T8 ?
2、项目改造+ z$ }9 h8 Z* D
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:; T2 }. d6 ^6 s$ A- u: M8 e
1.将package.json改造成以下模样:
4 z' ?$ r+ o% q
{
  "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包会失败。7 Z) s+ L/ t# `: W
3、编码7 g; x1 i& g) p
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:/ s7 R8 z5 C3 r4 }9 p. e. e
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。2 Z1 x, q+ _% j" |8 W; _" M
四、调试
( j( ^$ E+ I( N* c# Q       单纯的开发代码片段的话测试和调试都非常简单:
% ]$ }; S# z) p4 l+ b- b/ D
  • 首先先自定义全局的code snippet。$ ]" h2 j+ {8 T) s
4.jpg
9 ~" B( r. f0 v, k- ~0 h2 V9 w
  • 选择新建全局代码片段文件。
    9 s9 I) M3 c- b" B! o9 T
5.jpg
; u$ z7 b( f1 Q9 S; I' l
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    ; r. g' B" h0 @: g2 \( p+ X# y
6.jpg
# i7 ^. e5 l$ r" I  K
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    ! a. Z; K/ Z# |
7.jpg
7 T) S. W6 Q& d8 c0 L, O& z       生成的代码片段如下:
* b: b# M) h$ {7 l4 w- D; E
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;
五、打包+ n! w0 Q; G2 O7 F
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。* u6 \7 g. {% l4 U- R& L! n
六、发布$ N0 F9 N$ r2 `( E
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!6 B8 o/ r5 j8 C) g+ n
8.jpg 2 P# ~1 p$ e( x/ ^0 r$ m7 a+ U" n
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
8 o- {6 t2 G8 k3 \0 b0 ]8 X 9.jpg 2 k& D/ W' F/ A0 M, y. X' A  Y2 z
七、结语
! s% N- J7 a* c/ O- c+ `6 v       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-30 09:18

Powered by paopaomj X3.5 © 2016-2025 sitemap

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