QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5260|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言' i& U0 C$ @+ W8 C
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。4 h5 p# T4 h/ S
二、环境准备
, u# u) D- _, z
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    # G% k7 p! Q/ g6 p
三、开发者账号申请
  V5 L$ b1 s" `* Z       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。7 l) M0 q4 O- Q- r
1.注册并登录 Azure DevOps- C& z% y; f  D. B" c" T+ s
2.选择或者创建一个组织(new organization)。, w- Q' t; c$ z- G: i+ ^' [! c
3.在该组织下创建一个项目(new project)。0 [$ M2 M/ R9 Y' e! M- m
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
/ }8 v- S) A/ ]( r: A% f, D, r 1.jpg % ^. \+ Z6 T- o* h0 V; b5 V
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。7 G  l% G: N1 E0 K6 x" ]9 e
2.jpg / S8 U* A- ~8 m0 p
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。4 \" l! I% ~6 `; b5 E! _  u' W, d7 \3 h, `
三、项目搭建
2 f7 h3 Z3 t7 {' a3 R  }1、项目初始化
! v9 T. ~( v4 R% W  ~9 c' ]
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    . E( M2 O6 e1 n( \' E4 O2 e
3.jpg
! Z$ `7 J2 ?, I: ?6 r2 [, H! u2、项目改造/ `4 Q) ?) ^8 ]3 Q, G
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
/ j3 n4 w7 F: ^2 E7 C, @1.将package.json改造成以下模样:8 g6 M+ o) s% M, u
{
  "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包会失败。6 B" L, H$ V+ P' W6 n
3、编码5 r5 l1 |+ B2 l6 B7 U7 K$ C$ {
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:2 m9 O. H8 e, a; K4 q
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。$ Q9 h: S: e' x. {) a
四、调试4 q7 E/ j- h* \1 U+ J
       单纯的开发代码片段的话测试和调试都非常简单:
! `$ [) \9 o( f6 ~8 ^( |" w
  • 首先先自定义全局的code snippet。" y" c% _, Y% u& z
4.jpg % B% {4 H( m. Y1 x( S" Q; e
  • 选择新建全局代码片段文件。
    2 y3 Q, [+ i. c- k/ [( g
5.jpg
9 {+ N! G6 x: {
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。  k' l, D8 S: d
6.jpg 6 K3 w$ ?. e8 x6 _2 V# k- D! q
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    5 j4 {; t$ Y) j) ^; S: p' Q
7.jpg
* M; x+ m$ _: }& s' ]  G) e       生成的代码片段如下:( }6 J" u) @; ~. w( l" `4 D' m
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;
五、打包
7 o7 d- W9 z" g& t( z  V2 L$ E; x' v       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。# u- [. U$ n- E7 \# y
六、发布
+ \) S8 y3 s2 ~4 ?+ r: m" C+ t       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!& {8 E) H9 O' b) T) U' `. J! O
8.jpg + s: r* g7 B- [& y) N( h7 |! E: z
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
3 `: _, Q$ C) y+ I6 m  U 9.jpg - C  o) z3 p9 {  u. u  Q4 g* `4 }
七、结语
# u8 Q8 W4 e/ S8 a2 M! S       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-8-10 05:35

Powered by paopaomj X3.5 © 2016-2025 sitemap

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