QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4752|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言  I/ m9 X0 Q$ H& l# b
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
( I% q, Y! f7 e+ u0 ~二、环境准备
; f) y; H. x8 b  c
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    9 c: @& D& S* q/ C: Y
三、开发者账号申请
  X1 Q0 ]* R7 N. j+ O8 [       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。, c- ^, w* `# Y$ W5 y3 f5 z
1.注册并登录 Azure DevOps! j  ~: p1 q: U
2.选择或者创建一个组织(new organization)。
, |3 J+ p7 B4 @7 p+ M$ [3.在该组织下创建一个项目(new project)。
; s2 J1 N$ k& Q% Z9 U) J. F       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
, W! b" p) I' o; B 1.jpg 5 p1 b. |8 @: L1 W3 o5 V1 s
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
. x- w3 f" Q1 q. Z( k. w9 r4 I9 [ 2.jpg $ I4 Z$ P4 ^! k# L) L
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。5 Q( I8 A- V" U; C. ]/ [$ m
三、项目搭建( l1 k; t. J* t( z8 y' C
1、项目初始化5 [2 s* {- S1 X0 v. Q6 c
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    + |7 N& C' u; p# m; K
3.jpg 4 @0 `: K) P- ?9 ]. h; l
2、项目改造% |9 {2 b6 ]3 V; u+ @/ n
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:& ^7 a# w+ I' w5 y! z3 f9 [7 Q  \
1.将package.json改造成以下模样:
+ a9 ?5 i6 |" m' e3 K& y) |
{
  "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包会失败。# g! G% \$ N7 m. ~1 z+ |! @
3、编码
0 H7 m$ N. W9 d       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:* t% A$ x  c' C) }* Z2 S% T& g
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。# t3 K) ^6 A$ [# ~5 f# @3 y
四、调试
* {- w+ h, ?; s8 \2 u       单纯的开发代码片段的话测试和调试都非常简单:
6 G/ S0 N. w1 h6 b
  • 首先先自定义全局的code snippet。" p3 [- \6 k+ r/ T0 d- m
4.jpg   K; D9 m! {7 A
  • 选择新建全局代码片段文件。
      z2 W% I; I- W) |
5.jpg
8 r9 R& {6 }# E+ R
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    , L# ]! D3 G, J3 `3 J
6.jpg   P7 A; K( |( t$ V
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。3 U: F7 w' u: B! r
7.jpg ; e" F7 G( f" o4 C) `. Y3 U
       生成的代码片段如下:
+ e4 B9 \0 z9 }/ D5 N5 ]
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;
五、打包; _1 ~- K5 p% v5 X
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。  _" r! e( a# l
六、发布
3 v' i2 x7 |! Y: e       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
1 ^7 Q' a( |. z$ M, L 8.jpg
$ P# w2 O% y/ `/ v- h% m       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~9 x) r4 {% c! a+ v0 S- H1 N, M! Y
9.jpg
  L, S( B9 g" P0 C6 d" y- T# {% x7 `七、结语5 c* H: j# j- X. y6 o) ?" \
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-11 17:41

Powered by paopaomj X3.5 © 2016-2025 sitemap

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