QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5066|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言, C% ~3 @3 }2 n0 E5 ~! m
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。+ W! j) A; X* n% n
二、环境准备
) {8 l% _3 @( f
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g9 v0 K. e: a- i2 \4 q0 @4 b
三、开发者账号申请
4 c6 I6 s8 H5 h+ f. O       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
, [  T  r2 q! F5 n& ]1.注册并登录 Azure DevOps
) w3 A  N" ?; K: x) F# }6 m& C7 Q2.选择或者创建一个组织(new organization)。
6 o# S8 N# I' j2 N, G3.在该组织下创建一个项目(new project)。. N) y' O' H, p/ x+ r' _. A. F3 m" s
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:! z4 E% K5 y8 @$ a& A  F5 \3 `3 @5 K1 U- l
1.jpg
$ D2 g% x2 Z7 z$ T4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
0 Y+ z9 O: ]- F+ [  x3 B* }9 G 2.jpg + O  V" S, e& P  C
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
/ b) }- L" }6 K1 g三、项目搭建
* r) u5 L6 R/ e9 l; J& f5 _9 t- J2 j1、项目初始化
7 D/ e1 E1 l* u% S& O
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    9 D3 ^' t6 g/ T7 w/ k% z
3.jpg
% \% ]9 F# f/ G  t& A2、项目改造
. D2 w3 Z3 d( g# t0 b& n3 o9 J: |       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:; \8 a+ H8 S9 p
1.将package.json改造成以下模样:
* S* M7 W9 _+ H! x  V
{
  "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包会失败。# A# r9 n+ ?& v' ?) Y/ R% W. t
3、编码
. L# s7 x* v* V( H& q& E       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
8 z* j+ O- x5 f, @4 V9 u
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。% @9 S! Z5 L4 @* H. v
四、调试% I8 l! N4 B( l
       单纯的开发代码片段的话测试和调试都非常简单:/ ?- f% ?* B4 Q$ T) }
  • 首先先自定义全局的code snippet。
    ( M" B2 F2 }. u
4.jpg
$ x1 k5 {# b1 l* t) U
  • 选择新建全局代码片段文件。# \! L+ M4 \; X* V! @- r  E
5.jpg
) k/ A* j2 P+ x, Q% l! |7 k0 q
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    2 y: [, ^2 p: K/ v' C% x
6.jpg
) o: h6 i( A0 j
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。+ {/ G: ?# J9 _2 g0 }1 S
7.jpg ) @" I! s7 o# B$ C
       生成的代码片段如下:
2 Y1 S- {8 |. J( x
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;
五、打包( _% [7 ^9 U$ [; \
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。" d2 {- h4 f& `# A6 }
六、发布& {1 x; k4 H& H) x9 E
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!; i0 U$ y$ m: i
8.jpg , K5 s9 s8 D* y
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~5 s  @5 m+ a* k2 u8 j: m4 {4 \
9.jpg 7 x8 h$ e% f. |+ [
七、结语
& }. ^+ G0 P, Y* J! H8 g       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-13 12:25

Powered by paopaomj X3.5 © 2016-2025 sitemap

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