QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5044|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
- R6 T( C# Z9 @& o3 O, D       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
( K; [: t/ `  O8 V* {+ D二、环境准备1 @' K( z6 K: [& a) I
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g: O5 A3 C/ ?( x6 u* A( u
三、开发者账号申请
7 d- A# X: C8 D/ m, t       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
8 D$ j6 }1 B- M! B, n2 j  H/ _1.注册并登录 Azure DevOps
$ M1 Z; \' J- P( s2.选择或者创建一个组织(new organization)。# N" M% l% e. N9 J$ O4 H& {
3.在该组织下创建一个项目(new project)。
5 R( D& Y$ d6 U+ b: q       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
% O2 H9 ~# f. P 1.jpg / A6 @' O3 P# n2 l/ X, w( u
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
6 ~( ^( I4 b3 Z 2.jpg
, O5 w* y8 `# v2 C4 i+ G2 C5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
8 L  ?% f% t7 x6 d, O/ D三、项目搭建
7 B! H# e5 B: S, i& h9 ^1、项目初始化
; ?/ Y6 n8 \1 u
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。1 [5 W  [* c" c( X  O$ ]
3.jpg
' c* W3 E% c( s. k; O! b! f2、项目改造% v& o7 `+ e# ~0 W
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
% P! _1 c# p4 L8 r" _1.将package.json改造成以下模样:
+ T* {, `6 _0 \, Q# p, o8 b
{
  "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包会失败。, O' C7 r' w6 F1 G2 \2 @- w4 G
3、编码9 K7 h1 m+ l3 e
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:" V: y/ s7 m. a$ Q. M
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
! w+ k. o( X1 [9 f, ]四、调试7 u" x0 X/ X1 O  d8 E( b+ k- C
       单纯的开发代码片段的话测试和调试都非常简单:
1 x: K% F6 S# z2 e0 b* S
  • 首先先自定义全局的code snippet。
    5 K* |" Y6 P4 o' r2 I
4.jpg * e: V) e; g2 Q2 p
  • 选择新建全局代码片段文件。4 y4 d9 w" `, _6 l4 q
5.jpg : L) i; a' n, k. ]3 u2 ^$ o
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    8 o1 j3 z# G( F' @4 r- \# ?
6.jpg
4 x' c+ r9 l! l% O6 D5 `/ F
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。+ u; d- k. ~0 {$ F) C
7.jpg 0 U) _( w9 i. j5 I* ?
       生成的代码片段如下:
2 M. `, E9 v  g, S
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;
五、打包
3 |" O9 J) q6 W/ Z, ]       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。, a. z& F- `% M( `: N5 h5 _! p
六、发布) W! v8 _0 g% V5 k5 L
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
2 }: P: A$ u# X" {, b! P1 @8 J 8.jpg
8 w0 N# V" z6 B- g. Z+ f       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
" z5 V0 w$ D$ ~4 V0 A, }3 l6 R 9.jpg # d# A' w* z8 h2 u' l
七、结语+ ], g6 l8 J. J" ^: \9 f' M0 I
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-10 14:49

Powered by paopaomj X3.5 © 2016-2025 sitemap

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