QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5253|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
, ^1 {) J8 k$ ?       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
8 E# r( o, g8 g6 l" T) {: W二、环境准备
1 L2 O* X. b1 Y" Y) F0 N
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g, l* e6 Y* \6 O) F) a
三、开发者账号申请
3 _0 n: N' c: p5 N( N% G       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。7 E4 j  U' \0 u) a8 J; D- Y
1.注册并登录 Azure DevOps/ A6 G: S( R- B+ _
2.选择或者创建一个组织(new organization)。
+ I' c: o. e8 ~+ w2 R$ x3.在该组织下创建一个项目(new project)。
/ r5 R5 q' B' q4 Y9 Q# k       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
0 Z* H8 g9 e2 v6 j8 V" t 1.jpg
* f- `) h, K: S, m! t% D. ?; \4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
, h* L/ j7 n6 H) K1 M7 @" d 2.jpg
& Q9 N! e4 t2 L  T! u. V5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。* l; F$ }' @+ n% J! O- z
三、项目搭建  A! ^+ [7 v( \9 x# X9 H: ^
1、项目初始化4 W4 p, F" Q; f: Q2 ?2 O/ W& m
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。+ B+ _4 f( ~3 G0 R( a) j! f
3.jpg
0 g" S) i5 z  G2 w' Q* f& |! R$ M& M5 Q2、项目改造# |" R' W' T: I
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:: \# \/ ^7 S0 |3 \  l0 m/ W
1.将package.json改造成以下模样:! X- x8 k' U9 X  c! c! q+ k
{
  "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包会失败。; x: q; R( `/ l4 z
3、编码4 I' I* F4 v+ @4 i" d/ [* Q
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:! Q3 g- p. c% D9 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。0 U8 n0 E7 N7 p, ^. J
四、调试6 X& `$ V5 J9 @/ C8 u1 |( R" {
       单纯的开发代码片段的话测试和调试都非常简单:
- W. y% o: `1 w. ?  j/ q
  • 首先先自定义全局的code snippet。! Z8 p! \7 D+ ]* f+ V5 ^
4.jpg
& k6 e- ?8 e) L
  • 选择新建全局代码片段文件。' i! F( V" H3 ~3 k- j
5.jpg 4 ]( f) e9 t" o6 y
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。3 T) r3 x- ?  r$ e7 K, p
6.jpg - n# C! e8 y* e
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。7 I% U  U# ~# i4 d+ s) q
7.jpg ) Y' z1 j, a: t8 c# E# T& `" N
       生成的代码片段如下:# o: ^) t& N, u4 a
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 h* I0 q1 L, {- |, W2 ?
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
: a8 b6 f9 _% _0 n" g0 h& D六、发布
0 J' M/ N$ Z3 e$ O& u: w+ N       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!( @6 ?! `3 C; v
8.jpg * E- w7 \3 n7 Y
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
) f. S' c9 U: X' U8 G9 Z( k# j1 j 9.jpg 5 r9 V& z: K  f- C4 p' f' \
七、结语% T) n) H+ _0 W
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-8-9 16:33

Powered by paopaomj X3.5 © 2016-2025 sitemap

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