QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4999|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
6 G% |8 d! j' ]/ `       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
+ C8 b/ G8 j( J  @. |0 l二、环境准备" T( t0 k( P* Y7 u% R' a5 }4 Q
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g/ v& l; f( B! `0 g
三、开发者账号申请
# l3 Q; n3 B8 E+ V/ m$ p       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。# t; v! M! L6 h4 J; W* X
1.注册并登录 Azure DevOps' c6 c3 H4 {9 w$ |! _9 x" G/ I
2.选择或者创建一个组织(new organization)。
6 H" C) g" J( F+ V3.在该组织下创建一个项目(new project)。0 X+ p. L! X; E1 ]; U: q
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
/ y( _7 Q# `2 A$ t% r: D 1.jpg   _7 n+ i" h  B* b" ?9 T
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
9 l( c. v. g: P, U 2.jpg
0 t' W, F$ u' n; Z5 U5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
  {; a3 T0 @7 a  h# I, |, X$ n: M三、项目搭建
8 m# l$ b0 m( Q% Z7 E1、项目初始化
+ s  C4 M8 V: |  `
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    4 v( M# L# m5 [( n2 Y; g& S
3.jpg ( ^7 k2 b0 c8 _5 s* E$ I1 J
2、项目改造
& L5 K% `' [, v' s5 a9 K       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
, t& d& i& ^. `1.将package.json改造成以下模样:! @. T7 k. x: H
{
  "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包会失败。# B( @1 V$ C% s% J0 l
3、编码
9 l' c$ q7 b# e* E0 b       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:! f+ k; [- j  S; x! p
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。* V" y6 _$ Y% o
四、调试/ n5 ]0 s  a1 T
       单纯的开发代码片段的话测试和调试都非常简单:- f, A; [- y0 [( u  Y3 z
  • 首先先自定义全局的code snippet。
    ! J: {* H( K" x) V7 y( k1 s7 s, n
4.jpg
9 B* H- G. y- [8 z# b8 V) P! \
  • 选择新建全局代码片段文件。0 S! J& b/ I) T4 Y' y2 g' {" B5 l
5.jpg
$ M8 ^( k% K' f" s, F/ D/ B  {7 o
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    # ~3 g- Q! c; c8 f$ ^" e
6.jpg
) P+ k1 F) F& L& _5 U
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。+ e6 c) q4 x; C, s1 l, v
7.jpg
3 p7 Q" I. [5 ]! ]& j       生成的代码片段如下:2 w( S: W6 i! x) u4 i2 _* N" [* @
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;
五、打包
* \6 ?# Z, O: M       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
1 e; d$ x0 ]* Y6 d$ ^六、发布1 r/ y: t2 M/ S& Q
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
& m. u& ~; m3 ` 8.jpg
) F0 y+ j  O, G       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~8 L4 }+ r/ t5 B1 Q/ |% a
9.jpg : e2 z# P$ ?5 b4 M5 m. l) l
七、结语
% r9 b/ _: {. q( C( j! i       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-6 00:41

Powered by paopaomj X3.5 © 2016-2025 sitemap

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