QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4244|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言7 v. z* |+ D2 L# Y: u0 G  K% P
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。9 Q. Z. r, L* @1 h& F8 @
二、环境准备
# X. Z, R$ ]7 u5 C
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g  @6 c3 c0 G+ S) X0 j$ W
三、开发者账号申请  f0 q0 n9 E% [/ B
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
' z/ Q2 m6 x! V+ |, i1.注册并登录 Azure DevOps- N; j: G6 ~2 d5 n/ Q- ]
2.选择或者创建一个组织(new organization)。3 b, Y1 v' r9 N  t* T3 Y5 t
3.在该组织下创建一个项目(new project)。3 N/ Y2 v& X+ ?, I
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
' X# e5 b  Z1 D 1.jpg
% n; Y, ]6 U8 a8 _& J4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。, i9 x- S) a0 Y! B( `  r! q/ ?4 G; g
2.jpg
9 Z. Y7 s% w, _" ]3 Z* _5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
; m: G# q- f# @% ]1 K三、项目搭建/ O+ b& U5 T& N% m" F( l9 z; \0 y
1、项目初始化
' s' J: f/ [9 p. J6 D, e+ s
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。2 P% P+ X# i8 H& X  o* l7 j! N
3.jpg % q& c  \- g" N( }2 E$ T: A
2、项目改造
6 W8 i" I" g5 @       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:  L2 a4 Z( f/ }1 t7 [- _* g
1.将package.json改造成以下模样:, y, z2 P9 D! z5 C* O: c
{
  "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包会失败。
5 y* Q9 Z7 o8 ?# Y( j3、编码9 F. J$ @" C) T
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
6 \  v' T! F1 T1 u! o7 r0 q. ]
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
! h0 A- V& c! @* N四、调试
3 m9 g! ]# ~8 g2 y4 r       单纯的开发代码片段的话测试和调试都非常简单:
7 P0 b8 g* h) m3 |2 V7 A; b
  • 首先先自定义全局的code snippet。' z- ~3 D/ ~3 C  G# G8 B
4.jpg
2 H1 a& Z/ ?; v& G
  • 选择新建全局代码片段文件。
      ?8 b- K! ~. U
5.jpg
( k$ i/ z8 [  U. q/ a$ k
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。& [$ ~' I! ?0 B2 t
6.jpg
- s6 u( P4 @) g1 L  E8 t
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。0 ]; \0 c$ E: T' l  k( Q3 {
7.jpg
$ [' L, e! p+ v5 w2 F. |( |       生成的代码片段如下:
7 t2 n: _, x8 C' e
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;
五、打包) X5 s4 P$ m& f' y# m; ^8 b
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
+ d' f- T& m" z7 [! [7 z六、发布- S3 V) j5 C2 m
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
. U7 z9 u: K% `! K3 J7 x( `# f# D 8.jpg 2 u- p" x" s, _8 {1 W6 T
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
# T" d4 H+ X1 n& s) K* T& u* J1 l 9.jpg
, I. o: b( X% _$ e- {七、结语: h  g+ Z5 O  W" f
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-26 05:29

Powered by paopaomj X3.5 © 2016-2025 sitemap

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