QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5048|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言# B7 P9 D7 o) w) S4 k
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
6 m! I1 l; O: K" R: D* a二、环境准备* U- {6 @& b7 g) M6 Y' C$ N
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    1 ~4 A0 D+ h4 b4 q% N& e
三、开发者账号申请* {' P9 A- v  t+ s
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
( k- o0 @' N/ E1.注册并登录 Azure DevOps
) L6 [$ l+ W, n5 l# W, _2.选择或者创建一个组织(new organization)。* o1 o3 g' z# A% u
3.在该组织下创建一个项目(new project)。
; `1 N0 z9 `9 U& S. w2 B3 g6 g( @       以上三步都是为了获取开发者(publisher)的token,获取token如下图:5 v% O! D. h) s; o# ]- s
1.jpg 3 D! b& M1 r% x
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
: }! ^3 K! A! F6 w7 F 2.jpg
8 m% L0 o# F( t) ~5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。& w! Z; P( p( O+ u' j0 u6 M
三、项目搭建& Z. p  e7 ~: M/ _9 _1 f. K
1、项目初始化: K+ B7 j0 g9 [; X
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。, d& t" @7 @7 k$ l$ t" ?7 k+ y! x* h& B
3.jpg : J: ^8 u  R& ^) @4 s+ {% j$ ?
2、项目改造" h6 H* z5 Q0 |) R) v- {7 k
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:8 P$ ]9 y' t( i, U+ O7 m
1.将package.json改造成以下模样:
4 p: O! T6 j0 k% B. b
{
  "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包会失败。! H- l  v0 c! p9 L" I* P& f  [
3、编码3 Z/ H9 {2 ^0 W, J, T5 Q& Q1 `
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
! p* Y2 w, E2 s
{
  "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( r3 }; N2 h0 E5 `7 w+ H; H
四、调试5 j' e0 O0 q2 U' @7 v" L0 e7 E0 g
       单纯的开发代码片段的话测试和调试都非常简单:* G: S; d0 D3 s0 l# _" Y
  • 首先先自定义全局的code snippet。( r6 ?) x" A% J. B% c% S% |
4.jpg
  n8 ^3 H2 U- W5 Z
  • 选择新建全局代码片段文件。
    2 u0 U% z. `5 a; C" O
5.jpg
- u) v4 }+ {' ~! W. t
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。8 m7 B6 B0 x, }( K* n
6.jpg / ~7 H) f! u( f
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。9 H6 u) g  x/ g
7.jpg
& Z5 g+ ^& J' T2 U       生成的代码片段如下:
! ~, v7 u0 R8 t! Y$ B$ Y- F6 W* o
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;
五、打包
& i% U; V5 t  d$ o: k1 e9 Z" @! n       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
9 R& X, M' M- i. q六、发布
& |" }* E2 T2 M       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!1 p# v$ w  ?' T
8.jpg   g8 J# ~7 G! S  ?7 g0 _
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~# y1 l2 F8 v) \& _: T' R2 e
9.jpg
1 }# I. n3 k- @. v+ @七、结语% B" j" w6 Y& t6 S7 U
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-11 04:54

Powered by paopaomj X3.5 © 2016-2025 sitemap

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