QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4269|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言4 U6 Q' G( j* G# m- _" Q9 T
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。/ J, t" b. o+ I; ]2 r
二、环境准备$ }8 E% c! B# v" F# m& U
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g, d. f2 o+ u  x# G. A
三、开发者账号申请
. P$ W3 U2 v! y( T5 v       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。! g) V1 \# Q/ U( G# S
1.注册并登录 Azure DevOps% z6 j1 Z3 I5 [
2.选择或者创建一个组织(new organization)。
  O8 {2 }- F0 p0 g$ T3.在该组织下创建一个项目(new project)。
, ~% @7 g! M9 x       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
2 X* I0 L, s! Q2 ~+ `1 T7 G0 E/ d 1.jpg
) Z/ @% u1 t' p# n4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。5 `$ O& z, ^5 Z- x3 S
2.jpg ! U2 d% e' m0 q  K! I5 d
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。3 z" I4 M, g6 G# U' J! d) o
三、项目搭建0 Q" T2 q# X5 v1 c; q& ?
1、项目初始化, d6 m2 o* u7 d* e9 X4 L
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    5 {  L4 R, G0 J/ b  w5 e
3.jpg $ h* [" q* O* p. R
2、项目改造) e4 C3 {5 V3 M1 h
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
, }' t. ^- T8 w* N; R7 t; C- V1.将package.json改造成以下模样:
; N1 d) \; B. A+ O/ f) {
{
  "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# q. m1 C$ X  P, ^) b5 c3、编码
2 _8 Q: z: S8 z# P9 f* y/ h3 k       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
7 ]2 J( n3 I& {4 m; ^4 ?- ~
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。, W2 U8 ^* M4 E+ w3 s: M
四、调试
7 n( t, L6 `* ?% e( }6 b       单纯的开发代码片段的话测试和调试都非常简单:
+ V3 w5 S  D' M' _! s
  • 首先先自定义全局的code snippet。
    + ~7 U" N! C( h* Z
4.jpg
( ]0 t) r, V% v$ ~* Y" g" N
  • 选择新建全局代码片段文件。1 x9 i9 @2 s9 A  t- W) }3 C4 R; d
5.jpg
4 I" v7 z. ]$ F" w
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。/ o0 t( `) y5 N7 e
6.jpg
$ s( n! C$ o3 K8 O1 O( f9 E: T
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。% N. _- X& l1 f- d; ~2 L
7.jpg + Q/ l" H9 T) L) K/ k+ Q) j: D2 w
       生成的代码片段如下:1 d4 l+ X4 I; \( Y& ?- 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;
五、打包
; H3 ^) _7 d7 y+ t% z       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。# }; M4 C; C0 J' q& U8 s
六、发布
5 e7 d8 ?( M5 ?       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
& D2 R! \* w7 u+ B6 [3 M 8.jpg 0 _9 I! ?; u  z2 R0 T8 U1 l/ ]( W2 s
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~/ e, T  t# c& Y5 `- s. {0 N
9.jpg
; k& k% {& D/ s/ K# t* H七、结语3 W  O- x, H% N
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-2-4 22:11

Powered by paopaomj X3.5 © 2016-2025 sitemap

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