QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4602|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言! H0 k7 ]- `, e% C7 a7 V: B) h1 Q- a0 v
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
6 r+ _' R4 ?. c8 o二、环境准备
4 ~! V7 T5 X! P/ l* a+ ~' D( ?
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    ! _; ~8 b3 q, G, P; ^
三、开发者账号申请
: `( g: Z  w0 o# ]1 n- Z5 X7 u       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。. m; b1 {: D' M& u. v* U
1.注册并登录 Azure DevOps
' O7 _8 |4 P! r& s) ?0 @# V2.选择或者创建一个组织(new organization)。
8 H- v2 {: N7 }3.在该组织下创建一个项目(new project)。
2 F( e. i1 o4 O0 a% ]       以上三步都是为了获取开发者(publisher)的token,获取token如下图:+ H; @8 h7 Z8 f' A; w4 v; C4 u: t% V! ^
1.jpg 4 w7 |" _; x/ D; i5 a
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。& N7 X; z0 k2 i3 W
2.jpg 7 g( i  b0 B; l" |  [# o
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。, t$ H8 u6 z* U+ t) }
三、项目搭建
: F. f# J/ v3 t2 P  H* h" Z" z1、项目初始化' D1 W0 f9 I# h6 G: S" @
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    % N# i' e4 I% n- V, S! k4 g# b* X
3.jpg 4 D  Y7 F) l/ f: D/ W1 e% V
2、项目改造
% G2 L7 A0 V4 H- W5 I       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
- E. v! S+ `7 D4 a+ F  u) C1.将package.json改造成以下模样:
/ V7 G: \) W- m; `) f/ z  z& K, r( |9 P5 {
{
  "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包会失败。0 p  M' i, d4 T5 z2 h8 a3 r: O
3、编码
/ N, m) ?3 L) D       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
8 Z- w$ H+ ?- r4 }6 v+ J
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。: y. `7 O7 B. \, X( }+ a! R
四、调试& U' e! |2 ^/ L
       单纯的开发代码片段的话测试和调试都非常简单:
3 y; L  b3 i; h9 {; G
  • 首先先自定义全局的code snippet。
    8 {8 Y6 p  z: d7 U
4.jpg
5 C& `: f0 ?/ Q6 b: U
  • 选择新建全局代码片段文件。4 Q: O5 a+ A7 [+ M+ A. a
5.jpg % o0 o( h; h! Q5 m
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。0 W7 j5 Z8 B% M9 k
6.jpg , {  `! B5 |/ A4 F4 q( c
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。7 A* [/ U; l9 ~
7.jpg / \+ _( y: h- D$ x
       生成的代码片段如下:
) W9 S% |& ?% w2 x+ ~- f+ k
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;
五、打包
7 `/ ~' i+ `+ G/ T7 j  k       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。$ A8 {/ p' m, ~: t  |
六、发布
* D: R3 i+ g. t8 M5 i' D       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
; X# b. x4 K: X1 f9 x 8.jpg
+ @% E) j/ J3 `& h9 I       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~2 u  }' A# L1 h
9.jpg 4 A; Q6 b% [3 b  W& p4 G- L8 |
七、结语
; W/ _% q0 D5 f' p       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-17 20:54

Powered by paopaomj X3.5 © 2016-2025 sitemap

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