QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4612|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言9 `; C$ n. s. Q+ n/ ]" L% B; A; D$ h
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。1 n& `0 b0 M6 M5 O% p
二、环境准备  [3 o! E5 w+ x2 t( Y: u$ D
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    3 ]" d8 c, Y" L. T/ `& V
三、开发者账号申请% x3 S" g5 I$ x( w" v# q! u5 S, a
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。1 Q4 q4 J; Q' v: y
1.注册并登录 Azure DevOps
; b% X" o7 h5 [% p9 R2.选择或者创建一个组织(new organization)。
  k" H) X8 E0 `& \- k4 v$ z3.在该组织下创建一个项目(new project)。  ?7 ?/ ], B, L$ E" |. Z
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:6 b3 N0 @/ U& Y  F7 ]5 _9 z
1.jpg - ]; Z& ~) U2 m/ k* M( T
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
9 |% x. ?# L& v  }5 q2 V 2.jpg
$ u& m- G  R1 Z2 L: w/ e# u/ h5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。4 d8 f$ P- s. a  I/ L3 s
三、项目搭建
+ i2 @2 i, m( P$ d1 ?+ h. X1、项目初始化
) o9 Z/ Z, S0 w+ _, `; o/ T
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。: J0 P8 H* p  V+ @3 n1 U
3.jpg + B( z% B# z* D. O; B& r; c  n. q0 R
2、项目改造. h4 m2 m5 t# U3 }' t
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:: F. i# y; a7 k% f! i* Y
1.将package.json改造成以下模样:" _2 s& ~1 q# F! |2 b  |9 L
{
  "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包会失败。
+ m. q" n4 n8 m) {! L" K3、编码
6 ]$ z) e; t; B: Q$ s       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:# H9 H& q0 ]0 S' P" S7 `( ~
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。6 W3 Y2 z$ V4 _7 D  {2 Z, w
四、调试1 z3 j# v; m0 E! _
       单纯的开发代码片段的话测试和调试都非常简单:  c7 h3 u+ C1 i2 L
  • 首先先自定义全局的code snippet。7 F! C4 G3 E5 w1 {) E$ Y$ l
4.jpg
7 l; Q7 M0 s  R7 O
  • 选择新建全局代码片段文件。/ h  t& T3 Q, U
5.jpg
' o* \5 R$ p2 o1 |
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    ; g" h* W& T' E& b* V
6.jpg
) G! p/ T1 n# z4 V
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。1 {+ c& N' z6 R6 x2 N
7.jpg * C# v, {  J& t& o! {# D
       生成的代码片段如下:0 P: G. J1 D( s( L# P& t& M! u  [
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;
五、打包
+ H/ L: U2 f8 q7 U' L: f+ g6 l       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。) N, ~8 P9 y0 {5 x( X! I1 w# J
六、发布7 f3 |% h" o( C7 P% |% V
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
, c8 m5 R3 @/ e+ j6 q; E$ q 8.jpg
/ ~3 P6 M# E& M* S       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
4 s9 F: w) D4 C! |! Q 9.jpg : g2 f4 }" f% z+ ?% q& q  a: E8 }
七、结语. @$ J4 M' d3 x
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-21 08:33

Powered by paopaomj X3.5 © 2016-2025 sitemap

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