QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4470|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言, g7 C$ B/ ^7 y. T$ v5 ~4 r
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。- @1 C' }$ L# ?% z5 `
二、环境准备# z% l3 T8 n7 U2 t& G+ S5 d% K( a
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g3 a6 I' k' n1 A& J
三、开发者账号申请0 b4 T  }+ g1 g
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。' ~  K% d. o3 g$ i
1.注册并登录 Azure DevOps
/ ~0 j3 u0 M6 V4 N6 u2.选择或者创建一个组织(new organization)。/ ^- E+ H3 V, X
3.在该组织下创建一个项目(new project)。
$ F/ J: _/ o1 K* R       以上三步都是为了获取开发者(publisher)的token,获取token如下图:& {3 V- z7 A; Q+ Y6 X+ ~7 d
1.jpg
% Y# F+ b1 \  D! o% I4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。- Q- ?, t* ~9 J" X2 J
2.jpg
/ l  q  B: v& J! P3 C5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
  ^7 P7 X0 O; ]1 u5 H三、项目搭建
, f- u# s7 [6 M9 _/ u$ `1、项目初始化/ \- P2 n/ T0 Q* K' Z
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    5 J3 W$ o4 q8 e' D! I
3.jpg
8 M; S! [- O* @* K6 y2、项目改造
, e  s$ P0 |  S6 y; g1 M0 R       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
2 f* t: t5 x' v2 _1.将package.json改造成以下模样:
% Y% O0 R. V* _& g" k  w0 S
{
  "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包会失败。+ C. F4 O: p9 q8 k5 Z* {  h3 M
3、编码
- I+ j( a" `1 Q7 _       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:8 X2 i3 P( M: F' \
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。! ?( h5 j' L- ]& y2 Q' E& ?
四、调试
5 v9 n; `. e' R+ q       单纯的开发代码片段的话测试和调试都非常简单:
6 X- i( k4 Z, x5 [% _& F: ~5 c- |
  • 首先先自定义全局的code snippet。
    & W8 k  J  L0 N
4.jpg
3 D! v6 F" ^, V: R
  • 选择新建全局代码片段文件。
    2 h6 _& Q" e9 `5 t6 G6 i" P
5.jpg   E0 s) ]. l7 ]+ v
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。5 P& w6 p( x; {0 P+ [
6.jpg $ a: ^8 O3 ^& V4 K( u- }
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。/ _2 I& v' l: t2 {6 `. i9 _) D
7.jpg ) g. |& k7 \3 T8 y+ ?( A
       生成的代码片段如下:. }0 s1 @$ L1 u( s% h
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;
五、打包+ a0 h8 N& w6 \# Q, W
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
7 D1 f3 h0 g, \7 p8 I* Z六、发布
- Z  @" g4 i; g- ~       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!5 {6 W+ _* j- K
8.jpg
, }* m# U& f8 c/ Y% H5 A6 [7 b" e% H       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
* z) s5 M% c2 o) o, O5 r8 w( c 9.jpg + s" }& K8 k& l0 W
七、结语3 t" Y3 S: f! \* w6 S' s
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-4-15 00:27

Powered by paopaomj X3.5 © 2016-2025 sitemap

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