QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5172|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
! M6 P. p$ w! s: y5 O5 a: j       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。5 k( ?4 n& C7 y) Q- R- ]" N2 O9 z
二、环境准备
) f( G5 V. H# e; p) Z- S$ \
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g* S, y) [% l9 g& {4 j; W
三、开发者账号申请& o7 T) G; G% a6 u  z
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
( P) z, {4 y9 O4 g1.注册并登录 Azure DevOps
2 |# t- a* z9 x* N7 N  D/ D' u2.选择或者创建一个组织(new organization)。
$ D2 N- |! c+ Z5 }/ N3.在该组织下创建一个项目(new project)。
$ D# S) _8 J6 Q) d' k       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
  U6 t5 L; H+ H, v. U8 H% j 1.jpg 0 s5 b% V) G  }. u. u
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
& C, u9 |2 ]4 r4 }* H# _ 2.jpg , I. X2 ]. w" i) O% p
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
. X% i6 W% s7 T1 `" S3 r7 U三、项目搭建
/ e  R3 b; r( B! p- g' f" L% Y+ z- o1、项目初始化
+ p+ K' A# n7 a4 O
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    - V/ l" D; x( }9 r/ D& v6 J3 A
3.jpg % Q2 P" K/ f  F) Y4 B+ _( @! c2 @
2、项目改造
  h7 v( }) h& g       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
, T& }, x- r) ?! Z1.将package.json改造成以下模样:
/ E5 Q' A' X3 X* X# \0 _: _0 C
{
  "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包会失败。
! v7 u: G5 d6 i+ s% k3、编码
) \: Y" C6 f1 E3 ]       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:  K  s" p+ U1 O0 S" x, ~
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。$ ?: F: P. g$ \  s8 y9 p5 [, l
四、调试) L2 T/ o2 ]' G
       单纯的开发代码片段的话测试和调试都非常简单:
- J0 J/ n1 |; D
  • 首先先自定义全局的code snippet。$ S+ B0 Z" Q( V9 m" k* w
4.jpg
- J( Y0 O' U: d/ u
  • 选择新建全局代码片段文件。% B9 n. a2 @9 w$ q
5.jpg - C; t4 x; d$ Z& |4 D2 H) b
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。- P' d( R2 }( y/ B7 ]* N
6.jpg
6 g& v, U( y8 t/ B* D' O1 k
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。% v3 B+ S9 [( u, u5 n2 T( g
7.jpg - e/ U/ L6 ^# p$ B# e6 E+ l
       生成的代码片段如下:$ A# V0 u3 z; k* i8 p
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;
五、打包
) R' \$ |. K4 l" J/ z0 ?, D1 u       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
$ w; N* p2 q" g六、发布
  w! @0 E3 P" N+ v% \( r; m6 {  N       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
+ J* h6 ~  w1 d 8.jpg
3 C& h) Y% F1 d  R' Z: O       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~2 q: H0 L4 B0 {$ `$ e9 q4 d
9.jpg # `$ W5 y. }6 c$ C. Q: E" ~" Z5 ?9 p
七、结语$ [$ ~& J8 ~% Q7 O! Y! Y* ?# ?
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-28 01:35

Powered by paopaomj X3.5 © 2016-2025 sitemap

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