QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4958|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
4 V7 r3 C( {# `  g- D; c       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。8 @$ O+ i* a8 p) o% `) _, X2 |
二、环境准备2 a$ d# |+ a1 }5 ?2 [" a
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g: |9 z0 @* T! R; f, T. U
三、开发者账号申请1 ], z3 w, R2 O& P4 F( `
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
, |3 j" j; j) O% V! y1.注册并登录 Azure DevOps
7 ?7 w& O7 X) h9 t7 x9 n. n: ]- u) d2.选择或者创建一个组织(new organization)。
, w. p6 T" F" J4 {0 T) {3.在该组织下创建一个项目(new project)。7 o  |: c) z( p0 z2 O8 g
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:  k) Z: L, l5 l& ]& B+ p
1.jpg
1 p4 G0 J5 _8 w& T- u4 f, o/ X4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
' W3 L; ~: t& ] 2.jpg ( f! \4 b9 G: y1 I# [/ V" G: h$ r
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
: ^0 O$ e. _  z" d' f三、项目搭建
& I0 p  |  q( ~% p% \1、项目初始化
/ p$ q0 t& w3 z3 {% m  p. D
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    7 s0 K' V: g: J2 ?% ?+ [: ?* r
3.jpg # n' q# [& m8 o  s2 Y& X7 e& T
2、项目改造
, |- V; M3 w- T# I3 P2 z9 n: n# J" f       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:- l1 w7 U( J# L" A' W
1.将package.json改造成以下模样:
$ }% L& A) Q5 ~0 F  D
{
  "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包会失败。
( s3 h7 q' p" M, f0 H3、编码
2 c& ^& H5 g8 \: c$ @       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:3 O0 C) m/ U8 C# 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
( c+ k$ Z6 o; H( ?( E; P, f四、调试- j# Y5 n: M1 q. `* q
       单纯的开发代码片段的话测试和调试都非常简单:2 ~, a5 J: a2 {/ ^( W
  • 首先先自定义全局的code snippet。
    6 I  s1 D9 w! k$ @" g8 ^" @
4.jpg ; {2 l$ d7 q) n; Y: p0 U) b# i
  • 选择新建全局代码片段文件。! [  P& `1 f4 v! p
5.jpg
. T/ c9 }: R: C6 ]% }& |4 W
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    3 P$ m; x3 h# }0 Z: n
6.jpg
, F, [( v( s) c) [) }
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。) P: F5 b# F. l4 L) K
7.jpg
2 V5 t. a7 x( n8 @! z7 D       生成的代码片段如下:1 M2 U+ x' x+ h0 i  |: [
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;
五、打包
: {4 p8 Q$ V. w& \       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
& @! H) F- u/ D( S/ K' z六、发布' J7 O" J/ O2 r
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
; V4 a- D+ @9 f3 a9 {' x# ~+ ? 8.jpg 8 M! y0 Y& X, }5 @9 l& s" v
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
  [0 h; A- A! a2 Q* P 9.jpg # |) L& [: B1 _, f  W
七、结语8 }, a- M. [* S4 y2 A
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-2 21:04

Powered by paopaomj X3.5 © 2016-2025 sitemap

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