QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4734|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言$ h: c% x0 [+ l; \% T4 P+ l: t! X
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。8 j% h, o8 N7 c5 x5 v! v
二、环境准备
* X0 d6 ]- U# H4 l: s" N  D
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    & ~* X5 J% ~3 b6 ~3 S3 j
三、开发者账号申请
' d/ B( p$ K* K4 D0 m0 S       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
: y- g" o2 Y( G; i1.注册并登录 Azure DevOps7 S7 T- E0 o% N: a  S
2.选择或者创建一个组织(new organization)。6 i" O! w& s6 _  K
3.在该组织下创建一个项目(new project)。
, A8 m6 Z% m8 ~. I5 w+ H6 `0 @       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
7 ~+ g$ d7 F0 p5 \+ b0 S! Q 1.jpg
4 ], T9 ^: }! x3 |( w" n4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
3 V6 p5 `+ M: I2 _0 g* @, f) R 2.jpg * @0 S  u6 M# x/ N1 t
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。" S9 M" g4 j4 _" L$ W' ]1 |$ ~$ R
三、项目搭建
' y, Y1 k7 K, J" A1、项目初始化4 y5 E( Y+ ]6 F7 d/ K) @  a
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    6 N& s8 V' O- h
3.jpg - y5 w4 k# Z/ E7 j+ s$ v) @
2、项目改造# V5 ~+ B4 x, z4 S, z
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:1 a7 G9 P1 W2 @
1.将package.json改造成以下模样:
' N! @& m# u, y; J" p  w
{
  "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 L& `, P9 X5 }' ]3 V
3、编码! Y& z) E! |* p2 h5 E. o
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:6 W: I6 r* ]& D% x4 y8 h
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。: u/ M6 X) y0 d; n6 p
四、调试7 a' w) q) j) [/ r
       单纯的开发代码片段的话测试和调试都非常简单:
4 Z5 u% m# u$ t- r6 I/ M  m
  • 首先先自定义全局的code snippet。9 o& v1 f+ P& g/ v* g+ E: e
4.jpg : \. \. @% W  X1 s+ L  B3 J! I
  • 选择新建全局代码片段文件。
    ( O. V3 O" G! y0 Y
5.jpg
: M- k% E7 K- E" \) A" x4 w
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    & S7 h6 ^4 `3 j5 |6 T
6.jpg
; U& D) t' h# b
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
      y9 w# }0 q6 \+ n' m, ?
7.jpg
( j4 K0 `8 j. p0 h       生成的代码片段如下:0 f& w& Z) F3 E$ Y) h
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;
五、打包
; O6 M# A9 n4 V+ m8 H8 M       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
" s5 s0 A+ y/ G1 J六、发布
) D# Q' a$ Y: U       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!( _4 X, P3 u9 j2 _4 ]
8.jpg % p  [' s5 w5 y0 C7 L" e7 u
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~+ L/ m, r- i) F
9.jpg
: J" M* y$ K6 f; T9 U七、结语
$ T1 r' @4 f1 ]% {, ~) `       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-10 04:15

Powered by paopaomj X3.5 © 2016-2025 sitemap

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