QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5174|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言7 u/ [8 X: y2 b. _# ?8 E
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
: y/ U$ U/ w3 n- p二、环境准备; p' v8 r( U8 a1 v
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    ; m& q" o) n% b
三、开发者账号申请6 I  F1 ~& G& k
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。$ q$ b7 y; R2 E/ e# R. [% H
1.注册并登录 Azure DevOps5 Q# E& y- i4 ^9 v7 f- l
2.选择或者创建一个组织(new organization)。" C5 V# x; q, N, ~
3.在该组织下创建一个项目(new project)。
, _" \. A" r' i       以上三步都是为了获取开发者(publisher)的token,获取token如下图:) b3 U/ l. o8 n3 ~% v
1.jpg
% N# `' f) p6 O& X; `( t/ T4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。2 \; ]% R# e. C- z' i% ~( |1 F  V5 K
2.jpg
9 W  Y9 c9 ], o8 c) u5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
) P# c- H9 Z2 ~+ P: u: F三、项目搭建" X; g+ [% |# X  [
1、项目初始化
; T) N/ h) h) h
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    9 v: N7 e( P, t4 U
3.jpg 4 H% @9 D6 s" T3 ?' L
2、项目改造: W* R2 }6 \9 P
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:5 A; H5 N# Z( ^  s9 p5 k! r
1.将package.json改造成以下模样:
+ D& U8 w, O  j7 Q2 u: t
{
  "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包会失败。2 J& y" ~0 G' v8 z4 \- t: k1 O4 J
3、编码
, H3 p. U8 l7 e4 P+ l       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:0 N. q  V$ m2 @- p7 a
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。5 z# ^9 }6 E! @4 ]4 Y) F! [
四、调试$ _% I1 i0 l6 e* }6 u) S2 g
       单纯的开发代码片段的话测试和调试都非常简单:/ Z$ G# i( @+ [8 e
  • 首先先自定义全局的code snippet。
    ) }$ @, H- }, U/ c5 k, r
4.jpg 5 ?% X0 O6 L( Z0 v/ T* l/ C
  • 选择新建全局代码片段文件。
    ! ], u( s7 c1 _6 v7 I+ h+ Z
5.jpg
: P/ s6 t1 c7 `! N6 M2 k
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    ; v( U7 ~8 Q0 i0 X9 h' ?
6.jpg
( p- d$ D7 Q) o9 [+ W
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。- E" `3 g# f) P5 S$ x
7.jpg # ^/ g% E; e# T/ Q' r
       生成的代码片段如下:0 k& o0 J# s" `; L' v5 D4 @! _& 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;
五、打包
9 m/ N) _- X- M4 t' i$ H& u       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。3 V' x9 r5 i0 g& C
六、发布
. ]0 U' H7 r! c) |+ @; x# k       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
9 M2 y# T' C; d 8.jpg
- U- S  y6 D) [& N       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~5 _: G5 B7 g$ m8 g' h
9.jpg
" x+ V" [3 J% W7 a' D: w' q七、结语/ K4 [8 d3 N( o1 }6 L+ I
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-28 08:05

Powered by paopaomj X3.5 © 2016-2025 sitemap

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