QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4922|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言4 `/ ?  B( }' I$ m
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
4 d0 U* t5 I+ @' b二、环境准备7 a+ @4 `* R, N" S
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    0 a5 E  h% Z/ R- |2 J
三、开发者账号申请
7 N- V7 @/ q1 F  a1 v0 ~" [8 [       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。( [, E; {% ~5 ^0 Y
1.注册并登录 Azure DevOps
1 {: x( `2 p2 A6 S2.选择或者创建一个组织(new organization)。
/ k1 h0 E, u) p7 d/ s3.在该组织下创建一个项目(new project)。
7 V6 b" @( b7 }0 k# V# `$ r3 Z       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
8 t5 f9 l+ L! h+ u1 x2 W' p 1.jpg : f6 w6 B/ N9 {" {  ~
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。1 F2 `3 S+ a" g5 b. \7 J
2.jpg
) y6 E3 E2 S1 Y+ O5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
, `+ ], Y: R. K% a三、项目搭建; m- W/ F  J- l. q7 N
1、项目初始化
  w, u: U  p2 v$ @$ [
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。  r0 ]% d$ u1 o# M4 ~) X
3.jpg
4 n1 n- t& P% I7 h0 M2、项目改造
; R' W7 o' v8 ]3 h       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
8 w% B) ?* x/ I0 e1.将package.json改造成以下模样:' j! l8 |/ I5 G7 i. {
{
  "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 l. h/ t8 O, d4 h* e. _; W3、编码
, h. Y2 p. s" `5 x       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:) a7 |9 m+ T# P
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
/ \# ~; r$ \' V. A$ M) B- A: V四、调试
6 j. u- {4 Z2 E4 j       单纯的开发代码片段的话测试和调试都非常简单:
2 v- [) J- \" f: T1 T. T! t
  • 首先先自定义全局的code snippet。" n! W) n, P9 r! g9 X5 U
4.jpg " q. W+ S+ ^" U4 W3 m
  • 选择新建全局代码片段文件。
    4 j7 A' N1 ~8 R8 n* ~
5.jpg 6 m$ P0 w. R2 q; e( i$ G( b' [
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    2 d, K6 ?/ p9 _/ R% w' T
6.jpg 6 i  F0 F* f* m/ V# q
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。9 Z8 @5 F5 g: V
7.jpg ; R* e! o% v! J, ^
       生成的代码片段如下:8 A, S. T- j8 y0 n  G
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;
五、打包
# H0 r8 B+ W3 ^       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
/ [8 D5 G, m, \六、发布3 O' ]4 E3 ~$ @3 `# X  @
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!" A/ @( [9 u$ p  y. }
8.jpg
8 ]7 O9 `+ \6 _       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
& f7 b1 Z* M& F2 D6 b) D' C0 q 9.jpg
7 j5 U/ p! R. x5 x0 s6 q七、结语
5 J" C) j6 _! D6 W) ^       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-29 23:34

Powered by paopaomj X3.5 © 2016-2025 sitemap

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