QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4920|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
( B3 c: E5 S; g% t$ g9 G3 s       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。& E: r4 F# Z2 j3 I5 h8 i0 [
二、环境准备
' ?. A+ ~4 I5 N% l, s& E. I  x. U
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g. ]6 E8 j4 L6 E# c" R
三、开发者账号申请
1 J/ c1 Y8 |, a! K       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。+ [+ o! {1 S3 k, J4 m
1.注册并登录 Azure DevOps
6 O7 Z' M% B' _: R& F* b2.选择或者创建一个组织(new organization)。- E; h: q+ [  x- Q4 Q
3.在该组织下创建一个项目(new project)。, r& l! m0 V2 T- }+ ?6 O5 T; Y
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:8 {3 q9 k* \1 i8 v2 z
1.jpg
* e; f" H9 O+ q4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
/ h7 o! b: _  D" u' A 2.jpg 7 k& c; B! h6 `5 k% d
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
0 x- ^/ J3 g7 b三、项目搭建
( @/ g3 m8 b) T7 H7 P1、项目初始化" s! f& ~* @& @: ?) T
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。; b  e# W3 c! ]3 ^6 c& L
3.jpg * R+ j, n3 T& N' b# a! Y' y' \  K
2、项目改造* s, b+ \5 m: z% E0 W
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
7 U# K8 a: i8 A# N1 t& k; n1.将package.json改造成以下模样:0 \0 N- k0 n$ Z% g( |5 D
{
  "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包会失败。- F- U! A6 P0 h. L8 }. k) O# o
3、编码/ q* G  j4 V; h
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
& P" |! l! A: i( g# @# i; Q1 ~
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。$ f$ ?4 u3 V1 v' `% H; t% Y
四、调试
% d8 c+ I$ j7 @5 M0 B       单纯的开发代码片段的话测试和调试都非常简单:
5 A! @1 O' r  k2 P: ]
  • 首先先自定义全局的code snippet。
    $ X$ F3 W$ ?) Z' d3 J, o
4.jpg # p7 U, W6 p+ p, `: Q6 V
  • 选择新建全局代码片段文件。
    ' U6 m4 s' y* v2 Z, Q
5.jpg + m  w6 Q) r  g. X+ T8 @* ~! ]
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。: d# B! t7 K# G6 g, p
6.jpg 5 t* l/ W: K2 k% x& N4 h) Q2 i, [- t
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。3 g, L' Q; `: j2 e5 O3 D4 N2 [
7.jpg : m0 X3 r' V- g( }- [1 |
       生成的代码片段如下:% B/ l( R2 \) E7 }3 _/ P
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;
五、打包
( z5 O! o& S9 z& l- S       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。# G4 N/ v8 f& m) w. }9 V! ]
六、发布
5 k! i9 B4 u* N; l' P* B3 J4 [( b       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!" X" v4 `# D* }3 f1 H2 w& t8 V4 x
8.jpg ; ?, J' t& e8 v
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~# N' I  r, p/ B. M# s" o' z  }
9.jpg
) Y: X" ^: R$ t7 I1 S% b9 n  N七、结语
/ |% e/ B* ?* O& h1 R" S       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-29 17:01

Powered by paopaomj X3.5 © 2016-2025 sitemap

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