QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5189|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言1 {, N. ^% X; [, d6 |
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
1 e; z8 x9 F& r4 s) o5 g& D二、环境准备
$ `0 f) P* Z% h5 l% r  q0 s% f- ]$ S
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    * d8 k, n. E+ ]6 i% M: c
三、开发者账号申请
- C! Y, Y  R" K+ y! K       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
- e/ b! c; w- g) f1.注册并登录 Azure DevOps, K& A; i. i1 s
2.选择或者创建一个组织(new organization)。: Q; a/ F) b# _/ p. l& m  m! ~
3.在该组织下创建一个项目(new project)。
8 q/ d1 i9 h' h/ ?! \       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
5 {1 l+ l0 c) J  @: h 1.jpg 7 q# X9 z( Y8 N$ W: L) n! b
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
" u) J, e7 t( F! F# }+ g 2.jpg 5 ?2 Q2 P; R3 ~& T2 b5 ]* J
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。! i$ G! j& [& F; O2 I
三、项目搭建" X2 N; V* e& c9 {% j: g/ L" _
1、项目初始化2 C! p2 h# Q8 [" Z: ]& N# T* x
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    - z. o' w  k. a: o
3.jpg 3 [1 ]* l$ x; q
2、项目改造
- }- z+ o9 `5 C/ ~% ~/ p3 N       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
  x* }% v5 a7 M1.将package.json改造成以下模样:' O) P  ?/ J+ ?/ x
{
  "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包会失败。9 m7 A$ Q8 d- Y5 I
3、编码
0 V+ O, r% e7 U3 K       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:8 [8 c/ ^2 b+ ]+ M! H: j/ E! w( q  X
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。$ G* p, a( D& U' a$ e+ T
四、调试
/ X0 Q! \9 f/ g- o       单纯的开发代码片段的话测试和调试都非常简单:- i7 D) W  Z! @! Z# H, \
  • 首先先自定义全局的code snippet。
    3 J7 s& g1 P& n( g& ~2 R0 L
4.jpg
! j1 ^9 n% Q, V1 ~/ V/ W+ p
  • 选择新建全局代码片段文件。
    8 l5 z, A. B' m  ?1 s
5.jpg 0 q7 m+ H. W" B% U* d& o3 f
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    8 h0 s  X2 G5 ~0 Q
6.jpg
% d" J" R2 ?" _% X& W$ i( h
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。3 ?5 t$ J3 _# e; L& s: w% t
7.jpg 7 }+ x. j, C4 b% z8 K$ a& z0 T
       生成的代码片段如下:% r' R) `. H- B, v9 D4 Z  U3 u
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;
五、打包  |1 J/ ~+ V9 P% Y; y& H
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
5 ]& p4 d7 u% ?+ n  c7 C六、发布
  G# H- X% O% u& ^       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
- j4 n8 p5 O  t( }5 @' c 8.jpg
/ x8 a6 K1 @8 N: b4 t       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~, \6 E+ R4 s& t0 s$ u( {
9.jpg 2 Z8 L+ @& @4 C
七、结语
1 ~: E- @* M' ?, `6 A* {       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-30 13:26

Powered by paopaomj X3.5 © 2016-2025 sitemap

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