QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5097|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
9 A/ v3 I( Q( D' `) S! e       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。6 @. M# \3 N& q% X4 ?8 R5 B# B
二、环境准备+ T% \% @, G+ L0 `; t
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g  O8 m$ l$ }& K% d
三、开发者账号申请
6 a- i) v# Q5 |4 X- B% ^' \       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
% P4 b  W4 x# y2 @, L% s7 w1.注册并登录 Azure DevOps" b- Z7 u! H3 N( N
2.选择或者创建一个组织(new organization)。* h, `% V! K0 p! ~% ~
3.在该组织下创建一个项目(new project)。' A1 v+ p2 N( E/ B% p) U  }3 p
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:5 |6 X  v+ q3 i7 }% K. n+ Y
1.jpg
( f' ~" }! o( ]% p2 ^3 t4 b$ e) E4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
6 t1 q: Z8 Z, `3 t: {3 ~1 K$ \* A 2.jpg
* g5 F/ J" j2 U5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。6 u/ W# b3 R# @" K% A  {: Y
三、项目搭建
/ }+ U3 L. L7 o6 V" A5 j1、项目初始化
! C7 j7 x  m+ w% y( u* a0 R
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    6 g7 w$ j# b* U: p- X# n0 e; p2 z! H
3.jpg
- T- R% ]6 r5 g2、项目改造
( x) {# r5 Q. ?7 A) N/ i5 u       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
" q  u) N. W! P. b7 M1.将package.json改造成以下模样:
- x( P( t; v, ?+ `8 V; F: v7 F+ 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包会失败。
' `+ a/ n1 g2 ~( N7 J- Z. t8 S9 Z3、编码8 y1 Z2 p+ P9 H; D
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
/ t( @, R/ x1 D0 e  K/ ?) e" D7 ]7 r* I
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
3 C: r4 k1 t% W( H四、调试: N* n* @; |- f4 K6 \
       单纯的开发代码片段的话测试和调试都非常简单:- B3 u* ?  F$ J4 ?* F
  • 首先先自定义全局的code snippet。% w& m4 |- M# p7 i" p  W* a
4.jpg 0 \2 ~  |$ ?" l' s" L' }
  • 选择新建全局代码片段文件。6 z( l2 h. N5 B: S- A5 `& P3 }
5.jpg
- P1 V" I* R1 M
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    # c7 T; Y3 h& x+ I$ L  E
6.jpg
6 X8 z$ x' w7 |' M: f/ |/ R
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    7 S  u# {: X% ~+ R- v
7.jpg ( G* @* Q- M5 g7 \$ B2 Q- n6 O
       生成的代码片段如下:7 A* c; U2 f) B( L2 g5 Y
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;
五、打包& F1 R2 w' K4 n
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
' b6 j: x9 b1 `/ {六、发布
1 v" Q" F' E/ t0 T+ R       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!2 s& E' }# v7 i
8.jpg
, L+ d7 Y) l4 k1 a% K* M       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~9 R: W! m8 g; N; x
9.jpg * M8 T5 i0 M7 U: d% S2 s
七、结语, r* c, r' O  d$ c
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-17 03:25

Powered by paopaomj X3.5 © 2016-2025 sitemap

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