QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4852|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
" c# y( b+ {; {2 ?: h4 \       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。" F8 j3 W. j6 A2 m  g) Q
二、环境准备
  n9 \' b2 v9 a. _5 L) L7 N2 m. T3 i
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g( Y4 M' R- O7 u
三、开发者账号申请
$ c5 n, ?3 s, ]7 d3 {5 D# s9 u. ]       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
9 z+ s! E- D1 o4 O: \. c  }1.注册并登录 Azure DevOps9 R" j0 q& s7 f0 ~' c# H
2.选择或者创建一个组织(new organization)。2 u1 o7 A, E& c+ q% F1 E/ I
3.在该组织下创建一个项目(new project)。
4 T, Y2 j' j6 Z& c. K       以上三步都是为了获取开发者(publisher)的token,获取token如下图:/ A; J- e% G, w* B* {# ?  m& U
1.jpg 2 Z! I6 h0 S! o+ q
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
; ?$ `3 f8 c9 w8 I! k4 u6 R) } 2.jpg
6 B4 W- ~4 s+ u- X: d5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
  X6 V, e# Y4 I, Z9 L7 V三、项目搭建) ~% V! R0 f/ G
1、项目初始化
$ b+ Y* Q8 ^5 G' w" x; j; G& Y6 B) Y
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。# L0 X  N) Y* D" I: C% r! T4 ~
3.jpg 9 h% z! f2 Y0 H( R# E! g+ a' n
2、项目改造
- S9 H/ \0 V& B$ K       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:( x& T9 N9 F  o3 v2 |
1.将package.json改造成以下模样:6 x5 v9 m: L8 q# {) S( q
{
  "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包会失败。) R$ k+ ~' [, S. R
3、编码
4 p" d% P% m6 a8 b8 u" T& ]* p/ n       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
/ l7 w; X$ ^9 J0 R; ~4 h8 x9 o
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。& ~. Q$ i8 E) e# Z7 n1 {+ `
四、调试3 L$ F3 v' m7 A
       单纯的开发代码片段的话测试和调试都非常简单:9 V( i3 ?& N8 J3 {' Q1 ?6 r9 c, `
  • 首先先自定义全局的code snippet。+ X1 |# g( h& r, b( F
4.jpg : ^4 h% c2 [' U$ F! [8 a
  • 选择新建全局代码片段文件。; ^1 T0 r8 j9 e
5.jpg
3 o+ i3 i/ c9 n) C- G
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。4 D( f8 x  b4 A( K: ^: Q% X/ w9 w3 {
6.jpg - e$ ~8 B- {, H& g
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
      V5 O& P# @; G( c. X  F
7.jpg 5 n3 D5 x( i: [* c
       生成的代码片段如下:
, n9 L0 l# v, P6 u% n. v
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;
五、打包
' g; w+ ?! L8 C9 {  Q- Q       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
) M: d2 O5 |6 }1 }$ g六、发布
! O7 q/ C' k& i8 o' r+ D       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
- `% }/ u% h! C4 {% j* r 8.jpg
! D+ K, ~4 m$ G( U2 Y       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
/ u5 w6 T% k/ x 9.jpg
& `& l5 S+ I: E2 ]* T8 G( K! T七、结语
1 E, ?/ d0 W# l' y: u       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-23 00:17

Powered by paopaomj X3.5 © 2016-2025 sitemap

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