QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4783|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
) r8 j, I1 U, J# ]       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。4 g' R% n7 H- X3 R( f: e
二、环境准备. Z3 U$ {5 r# u" ~' |! M9 M) |
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g3 D* [& S& F7 w) L4 ]0 j& z
三、开发者账号申请
) F% @  V% U9 s       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
" k& X- f* l! B' C; a7 n0 @1.注册并登录 Azure DevOps
/ S% @/ `6 K) c1 h0 k! N2.选择或者创建一个组织(new organization)。# t2 }8 d! d5 f- F& K! L
3.在该组织下创建一个项目(new project)。
, Z7 C$ |' h/ \5 H. s       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
2 I: N3 n, s+ P# C 1.jpg
& ~0 Z  T" Q. z. N4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
1 P% A9 e. z/ }! O8 ?8 Z8 {- V: S 2.jpg 9 J. s- o0 [. Z; s9 y1 E9 j
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
* [5 J- ^6 Q1 a1 T7 S三、项目搭建
0 I. n; K* a% ^+ |1 ]1 [: h1、项目初始化
& s1 j4 I0 U5 F- d2 y% T
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。$ n+ M* |& }7 D, @8 W
3.jpg 5 Y6 F) O; e6 n) t" |
2、项目改造4 L: ?3 A* ^* W% x6 ^
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
4 V6 Z- W2 r7 }' s$ U3 M1.将package.json改造成以下模样:  I2 B; ]% y! J) ~* Y
{
  "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包会失败。0 H! b( k# ]' B, T- D4 Z  c
3、编码
$ D9 T" t# F. f2 _/ b/ r       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
) N* @% B( U6 n" P1 l
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。. |& O4 E" f- b
四、调试
3 p( p# }& B2 `, ~# S+ R       单纯的开发代码片段的话测试和调试都非常简单:
3 ?  X" i1 ~1 T
  • 首先先自定义全局的code snippet。
    ) F7 i% B; d4 z
4.jpg : r. Q, g9 r$ p& H7 t- A
  • 选择新建全局代码片段文件。
    $ x8 E9 q8 ?' w& _% s; G7 M6 t8 N
5.jpg
  [2 c1 k3 t3 G
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。$ w5 F$ f. ?8 U' ~: w
6.jpg
; I1 Q; N) t+ P5 o" I4 g$ T. x
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。7 X+ Y$ V1 o+ }+ D
7.jpg
  Q4 w; E* g( u' d- j$ A) p       生成的代码片段如下:+ B" v2 j* c' k) b5 d8 k3 o& ~
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;
五、打包8 F/ f, {) i* c
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。4 r# Y: ]5 |6 `; g. U5 t7 H
六、发布
7 l) v& H/ ?1 c1 i       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!- K# h; ~; }2 S; ^4 c, D' e
8.jpg
$ g( N# @7 R3 W' c# l$ e% s       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~" M; S# L6 X# u2 P% z
9.jpg " |+ b4 D2 }; F' n' ~# w* p6 b/ L
七、结语
% |  J- t1 ?/ \7 m- k* L1 [4 t0 f5 ^% _       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-14 19:03

Powered by paopaomj X3.5 © 2016-2025 sitemap

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