QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

手机号码,快捷登录

手机号码,快捷登录

查看: 2187|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

积分成就    金币 : 2857
   泡泡 : 1516
   精华 : 6
   在线时间 : 1317 小时
   最后登录 : 2025-3-19

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
( a1 r3 a2 ?9 K3 q' V& `% `* ?; }       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
1 t' G+ k0 e2 `" u. A" g二、环境准备
# w# l" I) v! I3 J! D' m
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g( L$ n3 M. A  z  L- ]( P4 d
三、开发者账号申请
6 _" s3 B4 F* ^% u. t. X" E       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。0 l3 k, C2 l1 ~+ o+ f1 T
1.注册并登录 Azure DevOps
. b7 b: [/ q3 U4 M! K2.选择或者创建一个组织(new organization)。9 q+ ?' ]1 H9 p* g8 X- q
3.在该组织下创建一个项目(new project)。
/ n; W$ ]) C# n+ x0 q5 e0 b       以上三步都是为了获取开发者(publisher)的token,获取token如下图:" y  W) z, S" z
1.jpg
: r+ R4 q0 C% v% F" t$ t# C! |4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。: R0 \8 F1 |1 V. Q2 G
2.jpg * c+ Y" ^& ^# }! S" o
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。: i. M8 Z6 P. _, Z/ F  n
三、项目搭建* r4 S7 n0 Q4 ^. `% \+ A+ Q& Z
1、项目初始化
: d; v% Q8 @( j/ B
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。7 t# h, h- |. {# ]
3.jpg 3 J/ K# c$ A& _6 W- X$ h8 W
2、项目改造, z* K7 S& f" i2 Z4 T( e
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:* k4 Z/ g# q, o6 c2 O
1.将package.json改造成以下模样:) P* H7 ^- f  J- Y! T3 c0 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包会失败。9 I2 K6 v: M' f: C# _# G
3、编码; Q" a; f5 v2 V3 ~" \7 n7 ]
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
+ Q# t( |4 g! n, E  `
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。3 S, p. K$ H- X; C
四、调试) S" w1 [; |5 q( N
       单纯的开发代码片段的话测试和调试都非常简单:! T/ f0 t4 \8 {& M" H# Q5 x9 [. ~; u# |! Q
  • 首先先自定义全局的code snippet。
    ) p6 X8 R" u& H
4.jpg
- ~0 B, z  ~5 s4 \, H9 J+ G
  • 选择新建全局代码片段文件。
    / X  ~3 x, {; ]& V. v) T
5.jpg
6 y( u9 B! i1 m$ m
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。! ]- h' t; G9 F8 _) U2 s. ]+ K
6.jpg / O1 ~" ]+ I1 W, j% X5 e+ @9 C
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    9 o- a: ~7 C0 o1 e* f! ]
7.jpg
/ S5 g* ^- @7 M  x2 Z. H0 o       生成的代码片段如下:  O' u, \2 W3 I: I
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;
五、打包, \% J- E# p- g, {$ I! l
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
3 A. q4 K0 ~* a# `! L六、发布8 F, O' |0 J/ X" n2 s0 b
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!& H- r- U8 E9 u& w1 E  b
8.jpg
% G# l9 _: S. q; U& V- ?       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
* H& C$ I1 U  T- w2 y4 f 9.jpg % t! d$ }& i5 H. _( D+ z
七、结语! h. G: b6 U7 t
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2025-4-5 05:52

Powered by paopaomj X3.5 © 2016-2025 sitemap

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