QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5195|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言3 O4 D+ {# `& I1 e
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。+ ~% _. }* F4 P& l4 v4 A* z- ~$ e  y
二、环境准备, l: \* m8 j5 E1 D$ S
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    ! {9 ]* g2 S& g5 r  @3 L
三、开发者账号申请
" \& k) `& C; [- v       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。! K3 D, p" {) ^" t3 m6 y
1.注册并登录 Azure DevOps; a8 T& m6 ?  {
2.选择或者创建一个组织(new organization)。
: V2 ^2 M- y  Z1 Q7 l+ o+ i' n3.在该组织下创建一个项目(new project)。
9 g' Q5 x( f% o9 \: I" y+ I       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
) D) D# J0 c5 c& h0 c 1.jpg
6 S3 C$ h  B" C# Z/ l, V4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
. H0 j# @3 V4 s" |& r+ {; S9 O 2.jpg
( Z& R5 ]9 r" x. k. `1 t9 K3 \, S5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。' e) J- E, T/ x. Y2 B
三、项目搭建; g9 B! Y. o9 _4 l  u' B# d2 D) S" l
1、项目初始化
" E. J. h+ i0 I) s) x9 Z
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ' W# J- ?( P* ?6 X8 @) u
3.jpg
# K2 }' R3 w$ Z4 I2、项目改造
7 y8 x0 l3 n* a7 H  @       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
/ ~( w8 m2 s% I) D. z% S1.将package.json改造成以下模样:- z, ^, \. @# g- A3 P3 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包会失败。
& l, H, ]: l0 H8 v  D+ `0 s- w3、编码! F7 L7 ]6 P- z2 s6 c
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:7 D8 j4 A- y; a$ J% u- I7 W/ 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。$ Y5 q- ?% J" m6 q
四、调试' H+ J8 q1 R: }6 E+ @" A
       单纯的开发代码片段的话测试和调试都非常简单:
" I! ?) {- s+ n! P
  • 首先先自定义全局的code snippet。
    6 ]! ?( Z) @5 c7 ~5 l
4.jpg ! J9 U( E. }  F: @0 d
  • 选择新建全局代码片段文件。
      p# }$ w" [; j: O: ^. q1 f# _
5.jpg
& ~- j( o1 a" e$ _8 d1 V0 W8 D- z: i3 K
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。. E5 h; A( J' N$ r; s1 r1 x8 {
6.jpg + [( O1 J; D0 w# F4 h) r8 j9 p9 d
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。- C1 O$ S* {: ~* J! I
7.jpg
/ S% f0 J; O9 t4 D0 [3 x       生成的代码片段如下:
) f9 P9 g. E" G) r' a) @7 R5 @
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;
五、打包$ _3 W' n$ x+ @2 R
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
! a9 n2 F+ W, J六、发布
: T  Q! C& g& L       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!" Z( c0 V2 h5 K) c6 f. ]
8.jpg
: y! E. r% \2 J) c' ]       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~% N: @+ @( h* J
9.jpg
, `- I0 I  a. J3 b% R( G七、结语8 \; p3 E6 {; w/ t- w
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-31 09:56

Powered by paopaomj X3.5 © 2016-2025 sitemap

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