QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4215|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言0 R& Y# ?' D7 J1 @0 c2 G7 K0 H9 a# }# ]
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
6 C" B! @$ `" F/ j. U) H) r# y二、环境准备. I0 ^- ~; D) C$ b% W9 e
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    9 D3 D4 Z$ A0 p+ g5 g$ k, y- [' b
三、开发者账号申请/ N  a9 v5 B% o1 @
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
' Q5 s0 X8 D5 f2 ]1.注册并登录 Azure DevOps0 F6 A5 p* ~5 {( M
2.选择或者创建一个组织(new organization)。+ w/ z; E& q: c
3.在该组织下创建一个项目(new project)。
! f+ p  f8 d( h       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
8 w; ^* w# z* A# x6 ]' J4 B8 e 1.jpg
- m- }0 o! l8 N4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。8 ~6 y9 U' |' h3 o' I
2.jpg
4 G1 w4 h- o9 W8 W6 e5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。4 K6 C  a$ Q- j; U- Z) \9 S- L
三、项目搭建
5 r3 I3 s8 G! h( ]" {+ a1、项目初始化
+ H8 y0 G, Y0 h" Z# s* o
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。$ s  [! l/ R. J7 C& g
3.jpg * H) U0 ^5 C7 h  b  C7 u
2、项目改造
, y  K2 U- ^5 V% r       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:" j4 Z# c, q& u7 k* s9 J
1.将package.json改造成以下模样:
% @/ t  [* C' h+ }; F
{
  "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 ]! j  k1 n( @0 M$ a: A' ?3、编码% v' k* Z' h6 A1 z& w# [3 H
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
! k4 y5 u- I$ H% R1 s
{
  "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  ]  G; t6 q4 k. L4 B
四、调试
6 K* o' D2 k. j' q" p5 [; w       单纯的开发代码片段的话测试和调试都非常简单:  W& F/ e1 X. y0 h6 F$ Z
  • 首先先自定义全局的code snippet。
    ; V+ S, C4 I5 t. l. O
4.jpg . `  G+ x! ]$ r; F1 A6 \7 T& K
  • 选择新建全局代码片段文件。
    6 v! \' a, n% [
5.jpg
# }% ^; E. b& N# p
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。% u+ A9 {2 \- H! M0 _
6.jpg % H+ a- H- Y! r/ m, d1 H
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。9 K+ m  |6 L: C# e
7.jpg 2 N4 f1 {6 d  Z: k( z  [9 j
       生成的代码片段如下:
5 T; A! y0 [9 b# B4 F
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;
五、打包
9 g8 \% ~2 X8 `, }( U       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
* W8 n, C+ k& L六、发布
6 j5 {$ {* ?) l1 R- X" d. D       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!' `) y. o6 K, }5 g
8.jpg # e/ I! D: E: K3 ^
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~8 G9 ]/ G' D- \1 \
9.jpg ( K6 J: U, }0 I! _
七、结语
3 r) x/ A: ~- ?7 V       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-20 19:31

Powered by paopaomj X3.5 © 2016-2025 sitemap

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