QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5214|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言! f! ], N3 ~. M$ H
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。, q5 [3 a/ {0 w% N2 x
二、环境准备
$ P3 a) |% Y  R# p
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
      x0 v( L: P( b0 Q; n
三、开发者账号申请: s/ y( y0 B/ h4 t% c) e
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。; [3 {! z; W( X8 L$ B" U
1.注册并登录 Azure DevOps
2 E8 ~9 a. Q& Y1 L2.选择或者创建一个组织(new organization)。
1 s% o9 ?& [6 g7 i1 E& ^3.在该组织下创建一个项目(new project)。
. R: s; D% m% \% d2 U0 T8 X. J       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
$ I3 j) d, ?8 n$ G3 E. D0 O 1.jpg . P+ i# t+ y0 w& Y
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。% W& ~' t* V  C: G
2.jpg $ F" h* k) x. Q4 L% A
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
8 ~' X: \" v- B$ i8 w9 v三、项目搭建
( }3 Z% P0 F9 i; F" T/ S# A1 m! |* A1、项目初始化
0 r' {% p* l: H1 L( ], V( y
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    1 \7 A$ |' m2 j, ?5 I/ v- _0 E
3.jpg - r! J: }& u: E
2、项目改造5 @# s2 v# B: L$ @
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
1 F( g5 w$ p4 F9 L; J  A1.将package.json改造成以下模样:
- Z0 u' z/ o$ x" u8 {& 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包会失败。
5 K  h) L' y  n7 g' c1 e, W3、编码/ o0 E; a) A" Q! O7 j
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
9 o5 k  c4 s+ Y7 }7 n; X6 V
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
! S' E' V. E; M! L四、调试" b) J+ S; z! S( k: @; x( s8 ~
       单纯的开发代码片段的话测试和调试都非常简单:
3 M* y+ y. c# o
  • 首先先自定义全局的code snippet。+ f% P7 w/ J) L& _' C+ K
4.jpg
; |9 t# p, x, L6 f+ a+ c9 _4 n7 U" F9 B$ P
  • 选择新建全局代码片段文件。3 @% T: `4 q+ D4 y3 a
5.jpg
2 o! g) A2 @0 e3 g
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。, @- n7 u8 V# Y8 e) i
6.jpg
9 O9 l& J; l2 k) b" `# v* Q1 F
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。9 _6 W* F5 w1 F) y+ k! T
7.jpg 8 b  k5 e( Z/ z8 r4 s
       生成的代码片段如下:& {; n# u1 K: j# b8 X( }  W9 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;
五、打包
: K6 |0 k; G" ^# X5 C) V       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
+ w3 V: @& v$ G六、发布
* p  I5 s1 R+ ?3 a       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
* @0 o: `$ N6 H0 @1 { 8.jpg
9 g6 r0 [9 ~) c  a       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~0 V) i1 L0 q( P1 S3 u5 H
9.jpg $ t7 R* u  s& C* ]* ]: T% X
七、结语+ r4 T& f4 l: L4 x
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-8-2 14:04

Powered by paopaomj X3.5 © 2016-2025 sitemap

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