QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4186|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
; Y' q  V, _6 ~) T) f       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
! V, d2 {( s5 N" e) ^1 D二、环境准备7 o0 h- i5 V7 B
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    , `4 n* d3 T) r% S
三、开发者账号申请
/ e$ O  p  [, ?+ e# R       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。1 Z! d/ v. ]1 V* y  G5 Y: ~4 |
1.注册并登录 Azure DevOps! P! Z% u2 f) \& ~# L  W
2.选择或者创建一个组织(new organization)。2 |. u6 d' r% I! q+ H- v! h
3.在该组织下创建一个项目(new project)。: b+ g; U4 _) D
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
5 `4 [0 {" d( [# E 1.jpg
0 u3 U7 L' \- k5 i& w. E3 l4 m4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
1 \* [6 i! R2 E3 t" B% \ 2.jpg
3 F  k/ V" H  p5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。/ _9 }* d9 Z& V. h( a5 S
三、项目搭建
2 m+ \+ b% o  W5 K5 L, ?' m- a7 j1、项目初始化
! m/ W1 K& }" C6 V  f
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    - i2 ?9 P4 d3 M4 O4 ~2 w
3.jpg ) o0 F# _+ x/ D& N
2、项目改造
& e6 Z$ @0 z+ m6 x$ E4 H       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:. Q) _2 z3 E9 g$ }
1.将package.json改造成以下模样:& D9 @, h  z) V, ?
{
  "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包会失败。  b' M* c) v* |" N7 J1 u! s) I
3、编码7 m+ k$ J( p1 e
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:. k. o; o2 z# o
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。/ A0 n5 \' Q. y0 p& I% r/ m
四、调试, r0 d8 T6 f- ^) }
       单纯的开发代码片段的话测试和调试都非常简单:0 I. h  N, X* w" n9 A
  • 首先先自定义全局的code snippet。9 s! P4 F, s1 l# F
4.jpg
/ }: v- S+ c2 X+ e5 D2 \
  • 选择新建全局代码片段文件。- m8 }: B7 C' X3 }* U
5.jpg
8 D; j; d% L! D
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    1 [2 L/ H. m0 T) h
6.jpg
/ q' n0 o9 n) |6 F4 Y& E7 o& k
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    . [8 Y& Z+ V  j( S0 ~
7.jpg
' x3 R- H/ Q+ J) R; L. h0 j       生成的代码片段如下:
+ ]; n- T$ l6 \% N
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 r# r( v# e- ~$ p
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: i7 a5 A6 o$ G# w! n* V/ Z
六、发布
/ s6 Q- ^+ G( U3 z- s       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!9 U: y0 `/ y6 k$ l* k0 E
8.jpg 6 v4 t: F! ^1 x! e# Q, n
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~4 d# H3 o- [4 f2 M2 p
9.jpg + b; w( s- v5 G
七、结语0 n2 t+ W, e  F- ^
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-15 22:46

Powered by paopaomj X3.5 © 2016-2025 sitemap

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