QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4184|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
4 o1 s$ Z: i2 |       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
3 L( [/ F8 P0 {4 ~+ c8 M二、环境准备0 L6 p& e# W( p# k( I- S- L" y
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    . t7 V) V% j) S- O
三、开发者账号申请
* g5 Q7 t# G2 K: E5 x, N5 T       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
# t% ~3 v1 e6 f* E1.注册并登录 Azure DevOps
# G' E) |; C8 G+ M, I% P2.选择或者创建一个组织(new organization)。; N2 j0 I) m) H% e; R
3.在该组织下创建一个项目(new project)。/ U; F+ ?+ V+ C
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:+ B% U( l3 A9 {' k1 I; G
1.jpg
6 h& |8 q& g+ y4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
8 d9 v- k0 i( r# G2 w% V  R+ G, \9 p 2.jpg 0 h; L9 Z  ^  u7 ?  g& n
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
4 |; q( [5 p! V  U三、项目搭建
4 y- G8 G0 G1 }" D6 Y7 j6 f% T2 J) X: R1、项目初始化; Y, `! }% w7 _2 P8 ?5 |
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。/ W! V/ b. O6 M3 g, a& i4 o! C
3.jpg
; K. b3 B' t( |2、项目改造  j. y5 R  G! {+ g$ ]
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
4 h( v" I- _% P: h1.将package.json改造成以下模样:
7 ?7 F' Z4 ]* F4 i4 f% M* `6 _
{
  "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包会失败。
2 ]* p( J/ }4 j+ I% U$ n5 m# J3 q3、编码
/ n* B" C& r3 X# Y       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:7 z+ {1 j8 R7 ]( E
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
7 _$ H$ g$ Z. c6 `: U# Q2 S: {四、调试+ }$ X6 C5 ^- Z* f" @; W7 k# P7 Z
       单纯的开发代码片段的话测试和调试都非常简单:
) ]( g3 k: C9 W0 T1 Y# a3 x* W
  • 首先先自定义全局的code snippet。) b; `4 i& ]; s0 o7 N: r: d& u: o- Z
4.jpg
9 i  t, w# M. g
  • 选择新建全局代码片段文件。
    4 D) C& Z! _& e
5.jpg - e4 n; l# T/ D" ^2 K$ U
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。% A$ S( Q8 F( t3 G9 P  h
6.jpg 1 d! X1 _2 J+ g2 F! l
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    + v  Q# H; |# K. [* z% k
7.jpg
, K. p  J. y4 R7 Q1 z1 G       生成的代码片段如下:
9 z5 @9 Y/ Q4 c+ f& N1 [( 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 S: P+ q: M) ]0 W
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。$ U/ I  A# z# @4 A3 ^7 a
六、发布
' u1 J2 r7 N+ b5 w" B9 S  L4 W       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!. k! W% [- Q7 p$ U; C
8.jpg
& Y' s9 q' x/ n7 s- z5 O. [& Q       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
; Y- Z( v) t. I4 \) q 9.jpg
3 a! g. t0 _' `+ J七、结语1 Y6 a4 G$ x9 [. z4 T) q6 I0 _
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-15 12:10

Powered by paopaomj X3.5 © 2016-2025 sitemap

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