QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4483|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言9 X2 `7 m' F1 b  g  a+ Y7 H
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。3 h3 ^) \' B9 o; K& M7 i1 C+ c
二、环境准备
4 B8 z7 M1 u/ I. ^- F: i& w
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    ' B- K- ]. y9 s* [& r9 g+ S" D- E
三、开发者账号申请
8 @" w2 d" h1 d' t) V0 H0 |1 r       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
7 v" [3 V% Q+ L& O$ v; r' b; z3 R1.注册并登录 Azure DevOps
- x# G7 o! q, F6 h9 o2.选择或者创建一个组织(new organization)。$ Z6 F* ?+ X' V. f: ]9 z
3.在该组织下创建一个项目(new project)。
, l3 H, u% R% @) J6 w0 S3 J       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
' N+ e4 t$ q& ~6 j3 M 1.jpg $ W& P0 h: q" n+ T! K5 U5 R$ x
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。- n: k' I+ G7 v) y& O
2.jpg
% B9 O# g, C: h( r5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。" Q% W, q  e7 h3 W: o" c
三、项目搭建
' S0 f' C0 \$ p9 |1、项目初始化4 o- s. g2 S9 S
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。8 J( Y$ H- w/ e8 ^$ y. r2 H
3.jpg % s! E6 V0 B2 Z4 O
2、项目改造  l8 f' O# I  H5 v& I
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:' J! ~# x2 V( a( ^
1.将package.json改造成以下模样:' ~  y8 A1 }/ N) ~5 Q2 U- g
{
  "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包会失败。
6 d+ ]( [* |' R" |# _4 j. [' p3 s& \3、编码
! X' T7 Y& f# d4 q1 B& Z       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
* p9 I7 F5 X* u# f: t
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。. y  Y- {9 A# _7 h
四、调试" K1 T; }7 p; \: `- x4 H% v
       单纯的开发代码片段的话测试和调试都非常简单:
; O7 d: l  f8 u9 C: a- Y
  • 首先先自定义全局的code snippet。; |( a/ D* F; D& _, v% J' @5 O7 D
4.jpg 7 {2 U% D) f7 O' k
  • 选择新建全局代码片段文件。1 G+ K* g* g8 V3 w; |$ z' P
5.jpg
% z0 |9 O/ y4 b: b! M
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。$ K& k* f; X6 e
6.jpg 0 `: B; f: u) e6 E& g- L( u
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。3 z5 m: L, V/ e
7.jpg
$ l% P+ H) m; K/ y! d2 U, k$ }) ]7 s. Y       生成的代码片段如下:
, F$ ^7 `% \. d3 U! i2 ^
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;
五、打包! N$ J6 @9 }: x" Y& n5 d3 g
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。$ }& ]; |- k% V/ m; @# n
六、发布. M% C* A  w0 a+ y- F! i% c2 g& K
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
- P& R7 P1 E5 U  O  v+ l4 s. S 8.jpg ; h9 }: t3 y- d* p. j
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
3 h) l. O7 P- P# b% F7 I 9.jpg 7 t0 b+ J, F& h2 p* V" D5 p6 E  c
七、结语" i; U$ B2 o# U; e# ]; {
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-4-18 17:30

Powered by paopaomj X3.5 © 2016-2025 sitemap

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