QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5223|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
* ~6 D4 p( C! w' I% I, `       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
( Y2 E/ d7 t' U7 f/ C二、环境准备" n* Y; A, C2 S( S- A( E
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    + n6 a3 M+ o, W9 v& N
三、开发者账号申请0 F1 B* N0 @# t) h8 [
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。: w% q0 ~' T4 o0 D! ]1 U
1.注册并登录 Azure DevOps2 x; T$ ^# s4 c) i6 p% f
2.选择或者创建一个组织(new organization)。( Z3 N% C& y+ c) e' a+ |0 I% h7 X0 D
3.在该组织下创建一个项目(new project)。" i3 u. q! T1 \: l: a
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
* Z/ @+ {0 Z( _$ d; A 1.jpg ( }6 V2 ~) u# E3 U0 F4 E  _
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
  W/ X9 v$ J4 ?; }* G& t0 N  B 2.jpg / D. ], o: {6 r
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。, x8 V3 b2 o2 U1 A5 p
三、项目搭建/ x* u" t5 b$ |
1、项目初始化
' A+ {8 @3 {+ r- x
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。. w5 H! z/ F; Y' i8 s
3.jpg , n. l2 J& s8 e* O3 Z3 |) @
2、项目改造: M; k- u6 K4 y0 q, F9 O
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:2 O, ]6 }/ k& U/ F' Z
1.将package.json改造成以下模样:2 }4 B) {  C/ z0 Y9 {# c. K9 i
{
  "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包会失败。
( q5 q, V4 }) ]% f: t$ ^% I$ D$ q  S3、编码
2 `( X# X) _# t/ t  N       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
/ p- ^( Z' b: ?& a% W# b8 ]
{
  "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 ^6 w4 N5 F" L2 M& k( a8 K
四、调试$ F* Q% ?+ J) ^7 U; [+ [
       单纯的开发代码片段的话测试和调试都非常简单:/ }" ], v, Q. V% I; M/ d: \
  • 首先先自定义全局的code snippet。
    0 O/ d. B" D, v0 e! U
4.jpg " D  o# f. K9 @3 I; P7 f" f
  • 选择新建全局代码片段文件。
    1 [4 o+ X. T+ V9 G7 P6 T
5.jpg
% ^" d+ ~5 b3 U  S# L9 z  r: |9 q
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。! A/ W" ~+ P+ M' o# T
6.jpg 4 M3 a1 x/ b4 R' Q
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。' H0 S5 R4 ^% e" M6 J$ h
7.jpg % b8 ^4 c' N& j& B* S- T; T
       生成的代码片段如下:
0 E: z. \6 B- b7 b5 l3 ^% d
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;
五、打包- V  L* E) M; K. `4 f
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。  O1 u  Y1 X) w- O, |( R, D( W! P
六、发布+ K9 g" M9 u: z
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!; v* Y& C' @+ s8 j2 t; ~0 [" }% }
8.jpg * ~9 s- U5 y" Q) ^4 K1 b) K8 j, C% Q. d
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~0 V$ ]- d2 Y& n+ I' U
9.jpg 4 D8 ]+ H) V3 f8 B# E3 V
七、结语0 y9 n! p/ \3 e2 [0 F! m
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-8-3 23:06

Powered by paopaomj X3.5 © 2016-2025 sitemap

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