QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5239|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
2 o+ n9 k- f1 O       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。# Z# b$ H! ~* ?8 t* r7 m3 W) M
二、环境准备
( i" J+ p0 {) s% v; N3 s
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g" c) H+ \; V( ~/ q: b1 o! s! ]- V
三、开发者账号申请
1 U" e- T; S9 p+ v- ^+ @( d       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
4 G1 X. F$ B8 ?. R+ ^1.注册并登录 Azure DevOps9 i7 \: E3 ]# C% Y# u/ b0 Z1 n; z
2.选择或者创建一个组织(new organization)。% r& K6 G. i4 }4 p
3.在该组织下创建一个项目(new project)。6 A$ ^! ]+ p+ H+ q, G
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:4 ^; ]/ r. q3 D5 y3 u+ G+ X
1.jpg 3 m& F# t9 u" [: X3 M# W  V/ ^
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
4 x9 l/ w. I1 ~0 _1 q! d1 D 2.jpg
. y3 o( }& v) X/ {% H5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
1 K. k: t+ |% A- Z+ }9 P9 p7 `三、项目搭建
5 K% S% y- o! r  @+ e1、项目初始化
/ Q/ L" W. h+ ^' ~* G
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。( ]; b2 T2 R3 X3 Z
3.jpg
0 R6 j+ D2 {, A( l8 [, P! Q2、项目改造
0 K- x3 f" i- c6 x6 b$ t( U       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:3 r5 y* m1 J" ]4 [' s4 o/ T
1.将package.json改造成以下模样:
2 F, L) j, n8 b) R; @# Q6 Q' \1 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包会失败。9 R4 t3 U. Q5 Y1 p8 U6 \
3、编码
( \% {. K# k' B! U4 o9 a! w       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
' `& t3 o& N4 X% G
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。/ C; W( d& m% h" ~
四、调试' f1 M/ {9 D  c# }  y
       单纯的开发代码片段的话测试和调试都非常简单:4 P* }- B3 _  b! L
  • 首先先自定义全局的code snippet。
    $ k: R  o$ U. i! Q! x7 P. M
4.jpg
/ L1 K# B5 e$ [6 ^( O( d4 }
  • 选择新建全局代码片段文件。
    ; O; `- ?1 V7 S8 r/ Q
5.jpg . i4 M; X+ \0 w8 L
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    % t, K1 A4 W" ]. V
6.jpg ) a/ A  Z9 b  N- |/ _5 N# e
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    ! K! _, Q- R  m& Q8 o* }! F
7.jpg 8 P# ]" C. ?9 ~6 s/ L! {
       生成的代码片段如下:
9 p3 F% Z( v; F3 f& G: v: Q
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;
五、打包
. G# u9 T6 Q- M       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
7 R& K$ d' c* u4 l; M6 C六、发布
1 [. D9 p7 ?% V7 W) o5 R       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
* @: L( p; I  ] 8.jpg $ K$ p: y6 k) t/ ~5 b
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~  v% k6 U5 N9 n, C* [
9.jpg
- W; |* R$ {% w七、结语
* f8 Q; p# A7 C* O       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-8-7 02:27

Powered by paopaomj X3.5 © 2016-2025 sitemap

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