QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4241|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
$ Y' |- \9 Q  P% {7 ~  m8 t       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。# Y6 d# n/ A+ s! q  R
二、环境准备+ ?- M. M5 @) o
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g+ l! Z5 c. K5 Z8 t7 n- o& l$ x5 G
三、开发者账号申请
+ z+ t0 e! N8 i5 Y       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
/ J9 o' m0 F7 N( {% H1.注册并登录 Azure DevOps
7 k7 x9 g+ i. s9 y0 D' @2.选择或者创建一个组织(new organization)。
! D; j; w; n6 W; d& c3.在该组织下创建一个项目(new project)。$ R6 E" `2 L4 w3 e  ^9 a7 l, F; x* z
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:) S# R7 _0 b  P9 h! a& u0 Q
1.jpg
6 h% V$ C1 X5 `2 n! W4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
. H( u0 P: x- t% z0 l! c 2.jpg
" j7 S) ^% H4 o+ m& [/ H2 X; Y/ H5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
0 Z5 a5 s0 N( x: }" W( c% f三、项目搭建# C" K0 A; G& I: J: z* T- A* ]
1、项目初始化! B0 t2 K! `1 Z
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。' G& I, g+ [7 M! E! L* q
3.jpg
1 Z. @& @- T7 Q+ S2、项目改造: g1 v6 M7 ~9 Q( Z% f
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:( {3 m7 n1 s5 x1 P
1.将package.json改造成以下模样:
$ ?" t0 C( w+ w2 [; t6 J
{
  "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包会失败。
8 m' [& C0 [' v* N) h8 `6 a! F8 r3、编码% g' o+ v/ v& T, }9 Z" b4 J0 o
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
: ?7 p, l, r/ Z5 \2 L2 k7 p% {6 T
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。1 L- y  T: Y! }- M( a$ T  x
四、调试! {0 B5 W. T% g- K# b
       单纯的开发代码片段的话测试和调试都非常简单:
9 o5 v3 f3 q! x( q: N
  • 首先先自定义全局的code snippet。2 X2 r$ y% f' a# O+ ]
4.jpg + z  i8 r5 h! ]2 c& y
  • 选择新建全局代码片段文件。
    $ P) M5 M% e! k1 C/ L4 g8 _8 \
5.jpg ' Y+ r- U  K# ^
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。  B8 q) a) l- K& o! q
6.jpg
) b" A2 e" O+ m
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    3 |- i* ~! Q4 n( Q) S
7.jpg   ~7 s% r  q' |
       生成的代码片段如下:; q3 u$ b2 G0 g$ T0 C- l- e
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;
五、打包6 ?" W/ t3 y& J( |
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。3 P! j0 a; D; v: R( L* r- l% z
六、发布# ?* @) d! }7 Y) _
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!1 S" f4 N+ _  F" Q6 ]- i
8.jpg
# A' }6 m9 J. i4 F8 z       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~! Q0 v  I2 x4 D6 A/ V! f
9.jpg * _! f0 G) k6 |' v
七、结语
2 t" a- q2 [  w- D% b% l       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-25 10:07

Powered by paopaomj X3.5 © 2016-2025 sitemap

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