QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4609|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言* f. c8 P# ~1 M. S
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。7 P* t) P( {$ F; X
二、环境准备
5 _/ B9 m6 O0 y* X
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    % ]6 u0 p& T; t2 T6 V
三、开发者账号申请3 ?4 ]- p! W' e$ q0 i0 z  b. C
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。0 V3 z, z0 Y% [. w: t( {0 N. E5 C8 }
1.注册并登录 Azure DevOps5 E2 r, \0 M2 B  B) _& o
2.选择或者创建一个组织(new organization)。6 d3 K  M6 L+ i1 ^- Y  C2 M
3.在该组织下创建一个项目(new project)。
  L; m; q2 H7 e3 z3 T       以上三步都是为了获取开发者(publisher)的token,获取token如下图:' v1 q# d. ~2 P; A/ V0 p5 K6 u* N
1.jpg # y8 E7 b. g9 A% Z  l+ q8 C& L- B
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。1 o" l( q! q2 J6 b
2.jpg 1 F' ?( {& B1 U4 j1 f% r
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。6 y, T6 H% h$ ~( E& f* c
三、项目搭建
( I3 I8 W* X5 A4 H1、项目初始化( s0 X; z; [+ u2 R' V
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。; j* O; k- d+ k! ?5 |
3.jpg & f2 y3 ^. v9 w7 A" C6 l1 w
2、项目改造
& ], k" p/ M' X; q3 }       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:# o$ ]7 P+ C& T; i: J1 G6 Z. x
1.将package.json改造成以下模样:
# T- b, K- w4 i9 |7 A
{
  "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包会失败。1 f! K! P4 v# b2 Y0 w3 A  i
3、编码
" @+ a. b) [5 z7 {2 Y8 d+ \9 l       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
; y- F! a: Z3 \6 b: H  _7 K
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。8 M2 I+ |4 H) I' c! x
四、调试# u! Z( K, `+ C5 |
       单纯的开发代码片段的话测试和调试都非常简单:! \+ T  k. b% ]# V# J+ R9 u1 f
  • 首先先自定义全局的code snippet。
    / ?/ O0 S! c# a( V/ @0 Y
4.jpg * A% x; V2 }/ R
  • 选择新建全局代码片段文件。
    " T! ]% C& T1 e6 |1 A! y& @
5.jpg 0 `8 O0 U2 V5 p" j2 y0 K! a# U& W
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    4 Q) L/ D5 q0 F8 I3 s
6.jpg
8 Z' V( X2 t  M5 g# u7 ]# O
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    7 R0 z- @% e  R( D5 T& r
7.jpg 4 \8 L- E1 r8 j7 I/ c
       生成的代码片段如下:+ M3 X7 U0 i2 J, x$ k7 l% _
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;
五、打包
' i6 s9 O0 f7 s       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。  r7 T. u# v, D
六、发布
" U; [  ~* j! K2 r8 \       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
0 u9 X; b& E6 Y; Q  P8 Z6 N& r9 F 8.jpg
5 ~+ T, ]& `& X       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~3 V* {. C9 Q* W: M, ?) h
9.jpg
' q* T1 X# x! {. T7 m; E4 T七、结语/ ?+ z/ Y1 k0 K/ ?
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-20 07:16

Powered by paopaomj X3.5 © 2016-2025 sitemap

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