QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4286|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
1 Z% F" p1 Q2 d2 I2 `) t3 i6 P" z  L       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。% U0 ?6 B; b* @5 C) p
二、环境准备
! T0 Z9 m8 k3 c0 ]) K1 F1 _
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    % h2 I# f+ E9 Q7 x
三、开发者账号申请, d2 x- ^1 u5 u" k
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。  a2 U5 l8 j) `1 G: u3 K
1.注册并登录 Azure DevOps
3 d  {- Y4 N6 c1 N2.选择或者创建一个组织(new organization)。
% A- i) t9 K; W, s/ y; `! `3.在该组织下创建一个项目(new project)。
, d6 `5 _5 e1 U8 p9 @       以上三步都是为了获取开发者(publisher)的token,获取token如下图:" J" U* k" Q4 s. J) a
1.jpg % l4 x+ [7 }# Q3 N3 e4 g
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。5 G/ G3 ?9 P( }. ?" N
2.jpg : H$ S( i9 p3 s: Y( M6 ?" Q9 Y& ?
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。; X2 E/ u, o. Z# S7 R, Z+ E; @8 j
三、项目搭建9 I1 j6 r) [% t; B
1、项目初始化. c: Y8 ^9 r/ f1 X1 C. W+ r( }" }' b
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    - k( j$ l7 z% i* O( A+ U
3.jpg " R1 P( V: l6 V6 ^* s; ]' A
2、项目改造
3 K% `3 q* p  W: G: c2 A       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
7 m* B; {5 q* e% R5 k/ A7 o+ w1.将package.json改造成以下模样:
) I, Y! K, r4 T! {1 Y
{
  "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包会失败。
/ n' j0 w3 w9 ?; H, j$ |3、编码2 q# C. k7 c/ o  X4 A
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:' p8 c+ b7 Q2 Q3 f7 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
& k; q/ x4 z, a. Y! a* r/ M四、调试8 r/ r) L! D* _/ B0 J( o" s
       单纯的开发代码片段的话测试和调试都非常简单:
8 [5 q- R8 m& T% g1 {0 D
  • 首先先自定义全局的code snippet。
    * N2 J0 @9 T7 {
4.jpg
1 j  a6 L4 _+ ]( h& E- Q% _; k! K
  • 选择新建全局代码片段文件。$ ^: q! ^0 y4 o) v, t% \
5.jpg
2 c3 [' U% W6 I' \& ~
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    + X& B8 E7 M; Y* [2 }3 s& Z' T
6.jpg ) L9 h# x2 H& X6 d) c
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。! E9 }! U  b* |6 h2 @/ j9 s' w
7.jpg - p5 Y2 ~/ }( _. u  e+ R  w3 e0 ]8 n
       生成的代码片段如下:( @9 f' t+ O5 g/ C. d: k8 q
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;
五、打包2 l; V) t$ q, r
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。* @4 R. n: i8 P9 n/ N3 l
六、发布
8 p% z9 |8 c* ^( }  `8 O       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
& x# e7 ?+ N/ @ 8.jpg 3 u2 P; H- f$ q" l% \
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~' C8 B% D' ]' r# x3 ?" W, A
9.jpg
6 y+ |6 {6 y) a& o. w七、结语
% r7 s1 Y' o$ V       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-2-10 10:44

Powered by paopaomj X3.5 © 2016-2025 sitemap

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