QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4197|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言1 t9 E/ C6 r" P) v6 x- \/ b* j
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。2 r: v: R# B. e, G7 |
二、环境准备
# _+ `: f' G. H
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g: H, `" {" N2 p* |
三、开发者账号申请' b9 B) p! |. G& p
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
- U" S  T' w6 X1.注册并登录 Azure DevOps
* x  X  C* C$ g, ^6 t2.选择或者创建一个组织(new organization)。- D! ~2 Y: ]! l; H, t9 ]
3.在该组织下创建一个项目(new project)。& l! y1 n' l# G4 r' b1 a0 ]0 U5 m( H
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
" }. U8 h0 T4 c4 k  ] 1.jpg
2 g) u* I6 _; p  G6 A4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。1 e# ]1 \& s& J& w. O: y: [
2.jpg 9 w% V( e9 {! y+ x; o* E
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。! w% d/ _/ i/ v  v3 ~% d8 }
三、项目搭建
3 \; B% g4 J5 b' ]1、项目初始化
/ F/ a( }! k/ s: U9 v5 a
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ) N9 Z9 F+ E) x  M3 C( t- V
3.jpg   g& {' u/ c; A7 y( i
2、项目改造* O* o- C+ m4 z& H) f; l
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
  Z% F2 W3 y) L* k* J' }1 L1.将package.json改造成以下模样:" o* ^  X4 O9 F) \
{
  "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包会失败。% H0 k: S- h* j5 g
3、编码& N5 `4 x) o" |2 m3 P4 k' ]; r  [
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
$ ]* H; w; V0 ]7 F- a& e5 Z$ G  f
{
  "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 a) i  `$ p& @/ E5 |四、调试
6 m: D9 V0 `  N/ ?' ^       单纯的开发代码片段的话测试和调试都非常简单:  Q% M* {" {# @
  • 首先先自定义全局的code snippet。
    2 X! g' M1 v3 ?/ q* F! s9 d' i8 i
4.jpg 7 ^6 ]( B, j. `4 m  d8 g
  • 选择新建全局代码片段文件。0 p7 J( s: b/ g+ A
5.jpg 4 ?) B3 n. ^& ^4 M1 `& [+ z8 v) _
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。7 h2 C" P3 b- Q. z" p
6.jpg ( l4 L& {/ t5 [* i' J; b/ L
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    . P' K& c. N" V1 f, m4 ~% y
7.jpg
. J" J/ Z5 ^, o1 m       生成的代码片段如下:1 X) t# [0 T( L0 ^& _: V/ z- {
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;
五、打包( X( M- m" ^" a
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
% b; r& F) Y1 W六、发布
! A# l2 p) m6 h; R7 L       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!9 H  l3 S  P9 t( f1 B- Q9 ^
8.jpg
% R! z. l( I# o9 v3 ^0 T! W4 `       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~3 c% P) J: \+ q6 i* o
9.jpg
! b9 ]% U5 u9 v七、结语
" B) O. d3 i! U9 i       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-17 05:29

Powered by paopaomj X3.5 © 2016-2025 sitemap

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