QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4484|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言/ g5 r. H! I' @( I
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。: y) \0 u1 E! e2 R. `5 R
二、环境准备) r6 x" H2 y4 A/ {- A
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g/ A0 a+ h; d( }; n& h7 N
三、开发者账号申请8 u8 i+ J, S/ A% k, h
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。4 v' }9 `+ h  t7 p; f( p" e$ C
1.注册并登录 Azure DevOps
' _, F$ I+ {* ?2.选择或者创建一个组织(new organization)。
7 \' {  o: c0 s' J; F2 K9 B; v3.在该组织下创建一个项目(new project)。% y4 u: `$ c- Q7 F
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
* t) y% _  L; k 1.jpg
9 b* D- D7 ]2 }9 D* W4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
1 P+ x3 p5 e  ?% c! {7 w 2.jpg $ u, M* e2 j; q4 d" R" f+ u8 S
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。2 l3 ?$ a/ u: B; v$ D
三、项目搭建
4 N5 @- _" S  D, H$ ~1、项目初始化
8 f) e3 ^3 L: r* Q! g0 q9 O
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ( P+ ?( y* a) K0 P$ N
3.jpg 2 `5 [: I0 G% C  h
2、项目改造% R9 s, b6 E0 `2 x
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:9 D* ?+ Y9 G$ n# u
1.将package.json改造成以下模样:; K8 N6 w: ~8 V/ X6 }
{
  "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包会失败。* T/ G, W+ D8 U; G' u; \" \
3、编码4 P0 x* L6 R' ^- T$ n' e" x. l( b
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
2 Z5 e( y' T' B" v
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
+ X7 G; _3 @  I; R" B$ ]四、调试: c9 }, J' N" o& f; O9 P8 V
       单纯的开发代码片段的话测试和调试都非常简单:
' q$ G4 U' p$ Y4 C. _- d! g& S
  • 首先先自定义全局的code snippet。
    4 g& n3 |% }' C' J
4.jpg & c5 y* x' F- G# {4 I% |; M* @& f2 C
  • 选择新建全局代码片段文件。" p0 L; O0 U8 j; c: o, M
5.jpg
: b+ I1 s; ^8 B( Z, O) v
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。; [0 [# c" r% ^0 T6 w: n* N/ X
6.jpg 9 v/ N  v4 V$ D, G& b& f' \
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    8 Q5 v5 h, W1 k7 |4 n) R. r* d
7.jpg ' z/ c1 I0 K6 U) d' [$ e1 w( e, |, o
       生成的代码片段如下:
1 E/ f1 a8 Y( B
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;
五、打包- ?1 }, Q) M$ R. a
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。- t5 D* T( m8 W& B" X
六、发布8 r+ X& b( C6 p% t& b
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
1 {* M" F  V0 H3 R6 @+ J2 g 8.jpg % @; J7 F: K4 w4 y/ z
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~+ M1 `; y1 I: C" H/ r7 U
9.jpg
3 ~& K, b4 Q  I5 ~* J七、结语
# L* ^$ m7 ]* ?) b! ^+ E& G       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-4-18 20:35

Powered by paopaomj X3.5 © 2016-2025 sitemap

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