QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5068|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言1 u5 M. W. [6 S& M# _
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
+ I* Y4 n* j% s) g3 w5 e二、环境准备
9 b$ C# Z+ t5 i& M
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g3 b6 C# O! {4 w4 F1 c* t( o# Z
三、开发者账号申请/ @1 ^% c6 g4 M/ E/ C0 Y
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
, k4 e& a) C7 j2 e4 o1.注册并登录 Azure DevOps) W* X: L0 I# J
2.选择或者创建一个组织(new organization)。9 q2 [* s4 g5 k9 t9 e1 Z9 _
3.在该组织下创建一个项目(new project)。* ?8 [* c6 ]4 Y' Y- ^9 U
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:8 a7 I& L# @' f* n' F. F2 U
1.jpg 2 ^4 q+ N2 x" N  b6 y3 |6 l" K' s
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
7 u$ {4 Y$ x; o7 v  @" f 2.jpg 7 K4 M2 X; u" z1 m* V- e0 q
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。, }3 |" O% v0 i5 S( M3 |; G0 M* B
三、项目搭建* y8 N' _: |; `
1、项目初始化
- y2 u( j% d# B3 f
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ; r8 j! N( n% [& A
3.jpg
3 g0 V: y7 l6 O1 H7 }2、项目改造
3 p- W5 r6 p9 q% x       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:+ }: p, `! i5 _4 |
1.将package.json改造成以下模样:
; u8 N! [& ^5 Z- m# G5 N; 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包会失败。
% c1 O( y) y0 y5 U# x/ Z3、编码7 q5 k  m6 N4 U5 v, I
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
$ @8 E, y( ^  b0 h* h4 U0 @
{
  "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 o) L5 i: H, ]$ A四、调试
" E% w: x  }5 {4 ?7 T       单纯的开发代码片段的话测试和调试都非常简单:
& Z3 s4 N/ D; \) q+ l
  • 首先先自定义全局的code snippet。
    # I6 |. L8 R, m/ U( C, W& K
4.jpg 1 ]" v2 v5 a8 D  o. A
  • 选择新建全局代码片段文件。
    " u0 }- [# _- d" ?* o7 m& G/ n
5.jpg
+ A% L( b, ~, w3 I7 G" n
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。' y  h9 W! f3 E& E8 e  Z! K
6.jpg / h& O+ l: D. x. C
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。" y2 I% M% c/ [: x
7.jpg : I5 `( i7 M5 j% g
       生成的代码片段如下:; Y/ K# o( I6 T1 `* _" `
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;
五、打包
+ o. R# o4 d5 P6 `       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。7 d5 P0 T' |6 S5 P% V
六、发布
( r' I6 n# g% N* ]1 l5 m. P( n       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
2 k# g) H( {8 }2 c8 H7 c 8.jpg 7 T$ l4 g! G$ k; z6 z; `
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
9 R/ W' h0 z2 c, z3 I7 v  ? 9.jpg
3 F4 f7 ^7 N: M七、结语8 q- b0 Z0 y! x8 E" m
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-13 18:54

Powered by paopaomj X3.5 © 2016-2025 sitemap

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