QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4793|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
4 f2 v9 Q# u; C/ c+ Q$ J       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
$ M, B* @! B3 w! R二、环境准备
; M3 A3 |6 x, c1 g0 [
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    0 @3 S4 G0 C3 X2 l7 W$ w& m/ {& {6 d; U
三、开发者账号申请; a8 i1 i2 R4 [
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。7 @! t! w. X( O6 R! A
1.注册并登录 Azure DevOps; f: X. _: c7 u
2.选择或者创建一个组织(new organization)。* e$ L3 I6 m( E$ h5 K4 g
3.在该组织下创建一个项目(new project)。& d  {. j0 R9 {7 ]) l& K' G! b
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
4 A, L7 w" D' T1 H5 U6 k& { 1.jpg 0 r( W1 i: E  }( U& B
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
& Q1 m6 T; G" O  ~" s 2.jpg
5 [1 j8 L+ d9 w4 d/ X  W5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。( \5 V  m% R3 x. }+ o" b
三、项目搭建
, e# C$ l6 z3 R8 [$ _' Y) E" w1、项目初始化
6 g' g. I# I0 b7 u
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。0 b, i& e  H7 Z8 v, ?8 ?: c' c
3.jpg 7 s7 k) q7 h8 w6 W) w
2、项目改造
2 @7 M6 ?9 ?- J6 S+ y! g) e       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:) q4 z( @# h' h2 h
1.将package.json改造成以下模样:
5 _) H: f, x/ t$ u9 N+ x. E* z
{
  "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包会失败。
5 ^8 o' S, L& ~& s3、编码7 b# f2 X8 ?/ G/ b9 ~& c, S& w; j  ]
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
6 v, O2 d, b) w8 z1 W+ c
{
  "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 \$ T4 D) Z四、调试
9 N6 ?( P+ Y; G6 a8 K- M9 D1 I, Z       单纯的开发代码片段的话测试和调试都非常简单:
* m( N; s  W0 Q  _* ~# D9 q
  • 首先先自定义全局的code snippet。% K8 Z3 O7 [. V# i+ q% `  j1 g  o: K
4.jpg
, N, |9 x3 J5 o2 h
  • 选择新建全局代码片段文件。
    7 P8 R- I, u& S% ]$ `& A8 v4 e
5.jpg
( H4 r, T% T: {
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。) f9 c% w! u& f
6.jpg , u9 L( j5 i4 R3 P' V! k5 [8 b
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    5 M! L  |9 R/ W- H( i' V8 o: ?
7.jpg 9 J5 U& B% j+ A% Z& @; F8 V! M  ?7 m7 k) a
       生成的代码片段如下:& h& h! d6 ~. K
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;
五、打包
: S- s6 C9 N: o- |) v       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。' ^: T% o7 u+ B- [& p2 C7 ~& U
六、发布
4 w: l! m' b5 i- D. x; C3 `       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!5 j' A+ l' p. r5 l$ `  P7 B
8.jpg
; ^. f7 W+ r3 C6 y8 n0 F       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
1 L8 Y% I. A$ h3 r3 Q8 y- a1 {8 ^ 9.jpg
0 l% y2 s7 F+ w: ]3 r七、结语2 r: D7 g3 J: d. ~( T* H
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-15 23:56

Powered by paopaomj X3.5 © 2016-2025 sitemap

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