QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4518|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言$ h6 J4 l3 w! D7 N% Q& Z7 J
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。' Y7 G. C5 }7 A& }8 h% m, v/ P' G7 O  K+ J
二、环境准备
- U7 Z* A$ I& j* n
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    ( k: N, h# C4 C5 o, q2 c3 u
三、开发者账号申请9 l3 U8 M+ K  P2 v
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
; O. B! l- Y* f0 X$ {1.注册并登录 Azure DevOps9 O2 x& }* ^4 i4 y; u& |
2.选择或者创建一个组织(new organization)。
  X" M8 k. d1 V" I" B3.在该组织下创建一个项目(new project)。
1 S$ i+ g6 q) F  s( u, k: S       以上三步都是为了获取开发者(publisher)的token,获取token如下图:5 Y0 e& T# l- B  C8 @, ?
1.jpg 6 |2 x" a8 \* D; k
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
- W  p/ a; _# a; s& V+ `/ [ 2.jpg
. c7 F1 v8 H6 R3 G# H4 g+ I5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。$ p1 W8 B: S. Y6 p
三、项目搭建
. U% @. Y9 p7 o9 l1 E1、项目初始化3 x) ?- M8 r- c, d
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。7 K2 J7 p, i& H! m
3.jpg
8 H& X+ F. P# C1 v' F2、项目改造
( R: r, R" C  L. u, O       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:; Q- a: F% L9 I- }
1.将package.json改造成以下模样:5 ~) L4 p2 M; Z. b  ^5 T$ }; S
{
  "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包会失败。7 h8 A' D3 g% N4 p+ Z
3、编码
4 a/ `/ q4 V" w$ D1 f; R       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:' o/ O+ J. f: `* ]9 \
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
6 k% T, q8 I/ ~& G+ f7 {四、调试
. U7 X% N( m$ e) u" m       单纯的开发代码片段的话测试和调试都非常简单:
7 o0 P; r9 @% u* i; A
  • 首先先自定义全局的code snippet。+ X2 c( [+ \& C* n" o( m
4.jpg 1 L. [2 a& w+ r
  • 选择新建全局代码片段文件。
    4 ]& ]$ ?8 l7 p! n: S
5.jpg 7 V7 [4 P) E: L* r, K3 a
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。2 }. G# \7 |8 q" F, j" ^
6.jpg
2 v" T' a  \0 [
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    9 f( }! X3 m2 {  i. ^1 Y; |
7.jpg
* \" i" V3 b/ F' U! S- Q5 j       生成的代码片段如下:3 K# l% `  v0 @
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;
五、打包( m) @  g. u3 d# N
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
! {+ j8 L4 y: u六、发布8 a! [5 F, Y1 R! g% Y
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!6 }# W$ W' h% C  d& U% e2 j6 \
8.jpg
6 I" A) V  E# j- i3 n9 D( S$ i       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~+ D1 b1 S% }2 B+ P* a
9.jpg
, W# F" P' M; P0 }7 y七、结语
; |$ X- m7 \& `. \/ G* q- J" [       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-4-28 23:04

Powered by paopaomj X3.5 © 2016-2025 sitemap

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