QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4557|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
8 K4 I/ i+ {+ n) _9 S       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
) m! C# ~' b: b% J( e& a' @二、环境准备
* k7 v$ W1 y0 e1 d# t, d8 P% V
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    " U  ^# R- D' z! ^% b" _
三、开发者账号申请
3 s/ b, ~" j6 Q       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
! Q1 y- p( `0 n' F1.注册并登录 Azure DevOps* _) P( }2 t" u
2.选择或者创建一个组织(new organization)。
3 R2 P! f7 ^2 p+ ?" m3.在该组织下创建一个项目(new project)。2 H- o% t- y, U, x
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:; Z9 V# v1 o' `/ T/ ^
1.jpg 7 Y0 c9 b  \  u1 G' ?7 K+ \
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。2 y$ d/ X( T8 p* l/ @
2.jpg
. ?) X0 n# n& N7 u! I- ?( L* p6 a3 Z5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
8 z( u1 O! c6 H) j" \4 o2 A5 h三、项目搭建) \% u) p6 {( _; ?" ~  D
1、项目初始化
5 {4 F' v- R! s2 ~- N
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ! \$ ~$ [2 x- o/ D
3.jpg
. T- e' l2 ]$ x$ j! Z0 C' q2、项目改造# `( l$ v. U: V' m! M0 @- m
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
/ y& J2 }- p& N/ q/ U1.将package.json改造成以下模样:% E; X, p" X" v- k+ z" M
{
  "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包会失败。( Q( [4 [- @3 i) g
3、编码* e/ g/ p  @2 o9 O' I
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
+ H. P9 |+ y* p1 f6 H
{
  "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 o9 R& [% h# I: U四、调试
3 o/ f7 h" X; t" J       单纯的开发代码片段的话测试和调试都非常简单:
" l, \; b3 ~" t5 ~: N- v
  • 首先先自定义全局的code snippet。* E1 {' G- B# H6 i* q
4.jpg
& A4 Y/ C* k) O8 n0 I6 g9 W% o! ~
  • 选择新建全局代码片段文件。* C% ]( p. ]/ j; [/ {, V
5.jpg
- C  v9 j2 R9 J' Y! \" M/ @
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。+ L6 p9 I7 e2 O  m6 H3 M. J
6.jpg
4 k$ Y0 p1 w; j$ d+ r- ?1 ~
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    . j! [4 p$ X4 b$ w3 t# S
7.jpg : ^: Q3 _! T9 u8 s2 ~: ?7 @* _" F
       生成的代码片段如下:$ I  k& j  _* [, V* L5 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;
五、打包
0 Y7 ?; |9 f& r       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。4 H" F" P$ |- l5 d% U7 r3 X! u' @
六、发布, P: e, t4 d% [7 a* I  {$ O4 Q
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
. ?5 d$ s" @7 N7 i6 m 8.jpg
6 h9 g" @0 z( }       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
9 s$ l3 ?  ^  A. ^6 F4 w1 B 9.jpg 9 ?# I# o+ G; {
七、结语
8 }8 m1 V8 ?8 R& k  K6 @- G7 U3 E       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-7 18:42

Powered by paopaomj X3.5 © 2016-2025 sitemap

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