QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4263|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
4 P7 o, K* ]& T, I       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
* m" F/ @1 r; t8 D5 L$ G4 D二、环境准备
! n6 C+ S* _4 @& z3 C
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    2 I4 j7 E4 N' u. s! E, Z8 I
三、开发者账号申请
: [( o3 b% R6 T" {4 V$ H       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
" R3 g. `  [& m' P  V: ]. n1.注册并登录 Azure DevOps8 l1 ^% f7 f: D0 U; Q1 L' g. U
2.选择或者创建一个组织(new organization)。
- m) e0 X2 m1 j7 M" |1 q* _1 z* z* V3.在该组织下创建一个项目(new project)。
5 e  T) E) v) a. k       以上三步都是为了获取开发者(publisher)的token,获取token如下图:, u6 y) P5 e( ]
1.jpg
, [& K4 o: s8 O8 p; G4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
1 h4 R; S9 E' j1 S 2.jpg
$ _, G0 z- _+ b5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
& G5 u/ e( S& ^# }1 Z0 a三、项目搭建
8 h! g/ ~- U2 W& V! s: w- V1、项目初始化
0 w/ N; H6 r6 h6 x3 T0 [: z
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ; t6 R8 S& }% [% c; F. M
3.jpg 6 B+ B9 l- p+ R4 p3 ]' a0 U) D+ e
2、项目改造! ?8 ]0 h, f! M- a
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
6 Y& C& f1 @% E5 R& n& M. y1.将package.json改造成以下模样:
* V% Y8 t& i3 S) V8 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包会失败。
9 g$ n# F; c: u3、编码
  W2 \- s/ W) h- D       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
/ g" \6 _1 P  ^* v; ~7 W" y& s- G4 e
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。! D' ^) ]9 K  L+ B) {# n# v
四、调试- B' Q9 V1 l' o# X5 F0 }+ v) U
       单纯的开发代码片段的话测试和调试都非常简单:
: b& C7 o& B/ E8 S1 z% X+ c
  • 首先先自定义全局的code snippet。* Z/ a! a4 L6 Y; A# @8 T" p6 ?: C: W
4.jpg
. g- q3 X4 ^1 r. S7 A3 T
  • 选择新建全局代码片段文件。4 t+ d9 h$ k; @
5.jpg
. Y2 ]# e% p0 U0 j5 _+ r
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    ! S) D# s  x& @8 _6 m/ W8 ?
6.jpg % R$ L# M" {# b  H7 ]: Z
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    & @) F( R; b2 x% w9 l+ p2 \
7.jpg 1 K% @( K- P8 n3 k& D
       生成的代码片段如下:
# \. ^- I* Y+ W5 g; V" O/ b# |$ \
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;
五、打包9 Q. s0 z1 n& M1 ]
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。5 g7 w- @' P7 a& \( W
六、发布& [! Y1 H: X0 A) N6 x6 ~& ~
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
% K/ V# M9 i: A$ ]4 A 8.jpg * W7 V: M  A' ~) b. o8 t
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~% V, y4 N/ `9 ~/ L' G+ M
9.jpg
! d/ n0 j$ }. z; R$ P2 I! `七、结语$ M" j  ~  [7 Y5 U) ]! U
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-2-2 02:54

Powered by paopaomj X3.5 © 2016-2025 sitemap

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