QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4820|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言" Y" i8 @3 d2 {- e
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
2 I8 E. @9 Y- g" e二、环境准备
8 [$ i7 ]) H% X' n5 b
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g; A" f' s9 F& m8 J7 `
三、开发者账号申请, |9 y/ x# w: G, A8 \
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。- e4 p+ L/ ~. ~0 Y/ p* s- j
1.注册并登录 Azure DevOps) E8 y9 d2 i/ q5 u7 w. d- \4 X
2.选择或者创建一个组织(new organization)。
; a: o4 e2 X4 x8 n& ^; |2 l  v3.在该组织下创建一个项目(new project)。
- C. O) e; j! f% k5 r1 R$ o       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
: m" N/ y6 I6 g' a$ x1 O- a4 i 1.jpg
; d8 `$ T: d4 O  Y4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
( [9 V" \6 U- i$ M) A( [ 2.jpg / a8 x$ r, r8 Q# B+ d
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
: Y7 [* F5 n, @6 u5 ]9 l8 J- H0 d三、项目搭建4 Q3 n6 a" E: _) P4 o/ H
1、项目初始化! K+ s! p% F+ I
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
      n3 r' i' {  X3 I' r
3.jpg
; `( _* }- m) h7 G1 F2、项目改造* ^, ~. Y$ c6 i
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
  @# o( S6 I% o3 C# q( w8 c) K" k" Y1.将package.json改造成以下模样:
9 q  B9 N3 _9 N$ b: h3 I" T- 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包会失败。+ {% x' t; y4 }! T* I- A  n
3、编码
5 }& d% l& H2 U$ O( X' m6 p) L       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
$ m: L2 q% L) E& D
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
  j2 C+ u4 w$ Y% E+ w+ Q. B四、调试* e# i+ Q% F" t, Y* @
       单纯的开发代码片段的话测试和调试都非常简单:
5 J" K, M% D( s3 X( s0 u2 n" J
  • 首先先自定义全局的code snippet。& g% x* [8 [, H5 [. N' o+ q* ^
4.jpg
/ B/ k% h  H) {# v/ n, S& I
  • 选择新建全局代码片段文件。( }3 X7 o8 p( O# a( f0 A
5.jpg ; J4 L; @+ M$ T7 V
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    6 k8 X# Z7 b, I4 \& I! s
6.jpg
2 A/ B7 o# `7 K
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    9 z0 L9 S. m* [. o
7.jpg
8 y+ d& W: M: j' K5 e' P' [1 h5 V; N       生成的代码片段如下:
5 u* T% X# Q5 x7 u- \( O/ R
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;
五、打包) Y3 R5 T3 v% P3 r
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
  M. J  K4 |% U9 h) E) T' M  P# `六、发布$ l9 M' l3 u% R, H
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
9 q' z0 ^5 G+ A0 A' N 8.jpg
! j6 \- I2 @7 c) W7 n( W  Q* s       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~/ |  y" D% B3 r, N. W/ M
9.jpg
2 c5 f3 `& L' W" }% u$ i* C七、结语/ m9 g7 F) m  `  T2 @# _: t
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-19 22:01

Powered by paopaomj X3.5 © 2016-2025 sitemap

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