QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4245|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
. Y9 i8 z* d* J3 [& ]8 D       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。/ I/ M  K3 `% v& J
二、环境准备
  d( y( J5 H  E7 Z+ O
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
      U/ b4 r/ w: b/ H
三、开发者账号申请4 Q% @( d+ f$ d% T4 o
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。; i* T. |4 G4 t& }, y
1.注册并登录 Azure DevOps
! i% H; H% m# ^) Y2.选择或者创建一个组织(new organization)。0 k" o/ i% d! ]3 B
3.在该组织下创建一个项目(new project)。& w# T# w. S. s; Z& r' O. f) J
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
( o( K+ d) U7 U6 E  n1 r( e 1.jpg
( t4 f8 }! ?- p+ ^" F  `4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
2 p9 ~. Q& s3 P$ K. d 2.jpg   J9 H  v5 r& _1 O2 W
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
6 V" Q# I5 F" }. R三、项目搭建' y, p2 {# O5 I, ]! P% a" B
1、项目初始化; h; M7 `6 {+ G; ^2 @/ U
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。0 A% d5 q8 z' c/ D  |* }5 K
3.jpg
/ E" x$ Z( Z9 \) p7 S2、项目改造  p) Q' s4 g' L% T% P6 A7 `  l( {8 c: _
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:  S9 J! |( t+ x) }# w% l
1.将package.json改造成以下模样:
9 P7 H' }4 R  F. s
{
  "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包会失败。" P% g* T4 [' m" n! p: i
3、编码: T* R: l8 j2 O2 k# O
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:) G/ j- L) O+ F2 G
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。0 d8 H- x6 k, y8 c' J
四、调试& J% p( h* k& W3 L0 e8 s8 j
       单纯的开发代码片段的话测试和调试都非常简单:
2 r* o% i! r8 d
  • 首先先自定义全局的code snippet。
    $ C7 Y. x& }! h  x( v- M
4.jpg $ u$ c# m  ]/ t2 s
  • 选择新建全局代码片段文件。9 B! }) q# B/ B6 S& P$ }0 w0 e4 {% g
5.jpg
& C, e) |% v% W8 ]1 t
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。1 s* t7 e. ^: z8 J) ^( L4 W/ k
6.jpg
2 l, k. _7 B+ }8 z& ?
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。( E- g' I9 {8 y* N* ?; G% h
7.jpg
  A! W. D- l/ ?. w- D  w  i" F       生成的代码片段如下:; ?4 s# r" k3 r4 Q. \$ \
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;
五、打包
, g5 j% b5 h; g% [2 }, v* W1 i$ K       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。; A3 p' X- p$ r/ X8 w3 v
六、发布
) A. ?9 L  F# x2 L8 |       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!8 E* H" J7 V/ c
8.jpg
+ b2 `; S( t- B. q1 D% R3 b! j# ~       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~; M0 X* O* U0 q) f. T7 M  j9 d! p6 n- U
9.jpg
4 y9 X7 e& v7 n9 Y; B七、结语' p/ F: Z5 _5 c0 H3 b
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-26 13:47

Powered by paopaomj X3.5 © 2016-2025 sitemap

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