QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4209|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
* R6 A5 z' {  S% G$ m! U2 b, q       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
* D' \# m( B6 v3 d/ ?+ y二、环境准备# ?( A3 v5 E9 g* |
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    - O: y: C+ E0 ^, o) s) g" N' D* s" U
三、开发者账号申请* s8 K# j) k3 [2 M1 ?" ~; l
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。. e" k, o/ i' `6 ~! ^+ X1 l* a
1.注册并登录 Azure DevOps
" Q- y1 `( t, d  z) B5 |: J2.选择或者创建一个组织(new organization)。
8 k' x: C! J3 f# g  f3.在该组织下创建一个项目(new project)。
. k0 k; }1 T. W: X" v! q0 F       以上三步都是为了获取开发者(publisher)的token,获取token如下图:1 b$ r% W2 @$ e
1.jpg
8 N: t+ D" j& O4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
& L& `2 j$ H5 N; | 2.jpg
/ D) J8 Y1 B2 }% |, Q: I5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
. \) O& o5 V3 D4 v$ Y* D4 D( k三、项目搭建
2 [( Y! v  T$ u4 J. W( z1、项目初始化
6 e& x" a- |* n
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    * ~8 H. v& z. H) Q2 b' D
3.jpg " j2 l7 {6 E' _! f* \/ y2 p( |2 |
2、项目改造
# X0 b+ k  G) M$ E9 V5 L. z3 l. w       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:- j6 I! W% W6 L% Q4 R5 y" y, C# r
1.将package.json改造成以下模样:
; Z- Y% N: R- k) t3 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包会失败。
7 P' Q4 [- }7 l* L# ]3、编码2 {3 R" S! c/ o& p, C0 {% N
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:, |; R3 K3 L$ E" E7 z/ {- B8 o4 y% ?
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。- [: G' w6 C1 F7 z! m
四、调试
$ a7 `$ i3 Y% P. M2 R       单纯的开发代码片段的话测试和调试都非常简单:  D7 K7 Q' ]$ c9 S* e8 |
  • 首先先自定义全局的code snippet。8 p1 ~! E2 x4 o7 \
4.jpg 1 ]; e6 e$ T+ T$ e3 `/ x; T+ |- s
  • 选择新建全局代码片段文件。4 [$ Z% w; Y' @5 r% n/ G: T2 Y9 i
5.jpg
( l: }4 t; Y$ i' j9 w0 Z
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    : y! }1 i7 e* V
6.jpg ; V/ _/ P0 \3 E' Q- ^6 v
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。4 o3 F! P, Z, @' b& I& ^
7.jpg ( T( D# J# q$ J
       生成的代码片段如下:
4 Y" V, w% R/ J5 g; C4 @
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;
五、打包' T7 A- y( `& |
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
) ]0 l0 g7 l  j4 a  n$ V  Q六、发布4 C1 W' v' |* p0 c) b
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
! a% s6 l) `- i: H7 v9 }- i 8.jpg / a6 e1 E8 T4 h  G
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
7 n& w* ]( s: k& M# M8 r 9.jpg
1 Q; @5 f, {5 P% r% y0 V七、结语
& u% P# o) \: V9 Y4 t( V1 D: g4 a       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-19 10:19

Powered by paopaomj X3.5 © 2016-2025 sitemap

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