QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4301|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言/ {/ N7 s! V3 K! G3 y" C3 t
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
& u( ]- d$ B7 E! B* [, ?二、环境准备- E. R4 {7 d9 x3 x& y: H. j
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g5 y/ Q! l$ E9 k/ ?- Q. _, H
三、开发者账号申请
( \& t4 Q) C* @' }9 u$ i       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。7 M, ?% {; j; l) q0 ]
1.注册并登录 Azure DevOps
3 k$ }1 ?% [+ D: g6 Y2.选择或者创建一个组织(new organization)。* Z9 o1 l& m) H. U3 Z& h. b
3.在该组织下创建一个项目(new project)。3 S4 w. N* N% i; ]* W
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
2 ]0 W- x' R/ n8 k: X; S- V 1.jpg   C; i. w# Y6 M1 Q% M
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。; U" E' b5 z5 l/ h, H, G8 X1 a
2.jpg
) j/ C% H6 x! ^5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
1 Y9 m/ D  L( G; E: E三、项目搭建
* \6 L/ G/ q5 F, ~1、项目初始化
% z9 K# R. a+ x$ o9 ]( _+ D
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    6 |4 P" M9 e5 P7 k) M
3.jpg 0 }' I- \% x$ o, s. E
2、项目改造
( Q! z) Q$ W0 h& c4 K' ]       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
* ?+ s. o5 p* H' G1.将package.json改造成以下模样:1 C: B6 [  K9 S# C9 h7 I# \
{
  "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包会失败。
! J! d8 ^' k7 T0 P$ d' ?8 V* ~3、编码1 y; h2 Y) s8 c1 \/ R" q' L+ O
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:9 |0 L% k" _& I, f- \" @
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。' G) U5 e9 u: E0 S3 d- k
四、调试
# d6 [9 s8 b' O5 U2 i       单纯的开发代码片段的话测试和调试都非常简单:
' h/ H$ O& [  ~8 b0 W
  • 首先先自定义全局的code snippet。
    & P9 F: L, S) }& {/ x( l* `* @
4.jpg
% p) _  V' t  U( m7 z
  • 选择新建全局代码片段文件。+ l/ N; O1 ^  g5 |9 ]
5.jpg
4 l) J4 U( _/ x' _
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。" u) A( z9 ^) @/ t% b: O
6.jpg
1 U  v- U1 R1 E% d$ h; y, c: m9 O
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    & M5 X; y$ m  \3 i+ l! t
7.jpg . W" S5 N7 a' c( H* Z9 S  q4 r
       生成的代码片段如下:1 a6 x  e" D3 Q7 q# W
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;
五、打包5 L9 ^: d, U# @  ]/ M- Z/ g% l
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。9 E6 W8 N3 P" t& A. Y' \$ z
六、发布
" X7 E( l% N2 l, ]( b/ K" n+ g       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
$ {' U! s7 G, I; C: f 8.jpg
3 \  p0 C0 Z1 ]0 g! v4 D1 ^; `       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
/ \! [! H; N) h6 o 9.jpg 1 m# u& Z# W9 H8 ~
七、结语' o' y  _6 M# l+ x; w" [" d, _' w' j
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-2-13 15:16

Powered by paopaomj X3.5 © 2016-2025 sitemap

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