QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5137|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言8 i2 d. |9 m4 q7 [9 b, V  P4 K
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。* M5 k5 O/ @/ [  @+ w
二、环境准备0 w& ^8 ~( P" |6 \  V% R
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    8 g, V! F4 N* Z/ r9 E2 t% s- c, P7 `
三、开发者账号申请# j& _" s# |- p! }& e
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
1 H8 O. F8 _( ^1 b" t1.注册并登录 Azure DevOps$ L' i8 m1 m/ M# e& G& g- f! l' {* t
2.选择或者创建一个组织(new organization)。
8 ?2 E; F: f( T$ D2 Z+ A- K, A3.在该组织下创建一个项目(new project)。
5 R: Y. s$ w, D# r       以上三步都是为了获取开发者(publisher)的token,获取token如下图:) u+ y4 Z. i% K* ?% D: q
1.jpg ( p% Y& T) R4 X' }( F0 L( h/ x" H
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
2 N: P3 y; _* p+ I$ ]+ p 2.jpg
0 v6 [4 g  x+ M$ j* j9 Y9 }5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
  f& o$ p& b% g% G+ \- s三、项目搭建, l# N7 H+ i  x4 M% x& T
1、项目初始化
* H) G, r( J6 ^% H4 N2 H& L% m
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ( j" z- K6 p0 K& x& z! `
3.jpg
+ l* S8 @/ x" }2 N1 M1 Z3 E8 C2、项目改造6 p, V  N; J3 x9 S2 [. P2 I8 _$ u5 y
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:8 X$ _5 @( Y" X7 P
1.将package.json改造成以下模样:; p5 h' s! }% \0 ~0 V: z
{
  "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包会失败。
0 E0 r2 G/ n, w5 W9 |7 m3、编码, \4 D; ?: x2 G1 E* {4 n% e# ~
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
+ e) u/ s+ [  E, I. A8 k* Z
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。& z& i, W# \" N6 A1 E- \* P$ H/ W
四、调试
. e% F+ [% y' T2 }( Y       单纯的开发代码片段的话测试和调试都非常简单:
, G; \$ K* p& Q. m$ u5 f) Q
  • 首先先自定义全局的code snippet。
    " k! D% @. Z7 R' T/ D# D
4.jpg 2 a( b3 i% s. R1 {0 U7 W9 A& }. z
  • 选择新建全局代码片段文件。9 J5 B, c* R4 C# y+ G# q
5.jpg 8 r  |# l" l! Q" M
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    . {* E& S; v6 t4 f* `
6.jpg
, V% p! }: X  F, p9 Y
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。! j+ n/ X: A2 b( K2 g& f! O
7.jpg
4 ?; W5 a- Z" y4 n1 F) C( q       生成的代码片段如下:' k9 [1 J, d  C- z$ f) 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;
五、打包; D5 v& \1 Q3 U9 M4 m9 c
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
- F9 L/ k' w, Z& i( o& p六、发布
( `3 G( n$ |0 U: ~! B2 }/ r# o       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!$ J. x7 }4 \! S1 ~: d  X. l9 W
8.jpg . ~; R2 ^+ _0 o* o3 X
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~. |3 `' J: [0 k" a& E2 v
9.jpg 5 u- y/ d( u% }3 [3 u3 U, k
七、结语* e# ~: ^) N5 S, n+ U, d
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-23 11:30

Powered by paopaomj X3.5 © 2016-2025 sitemap

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