QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4712|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言1 x) Y9 A9 A8 |3 J
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
* i" L  J7 U" e6 x; d二、环境准备9 B- K7 K) Y6 r; D( Z. u! X
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g5 h: i9 U$ B( g2 P- y" F5 c
三、开发者账号申请
) S+ @9 D+ E0 O9 U$ ]% [. g7 C       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。5 [% _7 b/ O# n
1.注册并登录 Azure DevOps' S4 L  i3 o& t
2.选择或者创建一个组织(new organization)。3 a& l# K, ~2 F+ b" k: s
3.在该组织下创建一个项目(new project)。6 {, F4 R" I  H$ h! L
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:+ A  d8 {" i0 `7 G2 O/ O
1.jpg
. |% H& q+ m7 h& h4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
1 p% a# L$ o2 ]+ B( v9 X 2.jpg
. A$ C3 x; E4 z' A3 o5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。% ]* k, x$ Y5 n* p) b
三、项目搭建
7 G' [5 L' q2 ~& l! O$ v1 I1、项目初始化! ~  Z# O. v# c& L$ G7 Z
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。! P; z+ s9 I4 C! E
3.jpg
7 y; }9 T1 \, m. p" r! T2、项目改造
1 E$ u+ {1 L% D" Y! `% e) ~       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:; y  D$ b4 e  Z/ r+ m
1.将package.json改造成以下模样:7 d! b9 L" p$ d* p) v
{
  "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包会失败。: w9 J1 E0 b$ H0 j
3、编码; L7 a0 M9 p- a
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:! f( k0 C9 l! i/ h
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。, U' A* c+ X2 d
四、调试
' A2 [4 T/ o3 q, c6 e       单纯的开发代码片段的话测试和调试都非常简单:
2 \, n" c, y2 f7 u3 g3 ?7 q
  • 首先先自定义全局的code snippet。
    $ W+ a6 z: S" j9 Y0 H8 Q
4.jpg
6 W1 n3 {9 D; N5 F
  • 选择新建全局代码片段文件。
    : {- w/ R" ~6 F- |( Q8 [/ ]
5.jpg
- M8 ]4 B  l% z2 X' R' m
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
      S  l5 L# E0 E  I1 c
6.jpg 5 `2 c1 L9 ?* v  [/ F9 y
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    $ ^, l, Y- T' f! s6 k
7.jpg
7 m4 X+ d4 P- H5 J7 W       生成的代码片段如下:) P/ {  l- Z8 O  n! u9 d
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;
五、打包0 X8 @6 D2 l/ b+ A1 Q( l" N1 ?
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。( }* k# t* ^+ d
六、发布/ X: d& u# M. ?1 d5 F7 x% f; g
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
7 l3 x) |5 g1 K: \2 k: I" j# \ 8.jpg ( f/ V5 h0 T$ Y+ E: P% W/ x0 Q3 [
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~& r, z% z$ K0 g* P6 j" M
9.jpg
: u" Q( S: ^5 Q' e) s. P2 _/ h) y七、结语2 ^: B) W4 z( }8 C5 _$ s
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-7 13:52

Powered by paopaomj X3.5 © 2016-2025 sitemap

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