QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4246|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言: ^" t8 q& P' d& |# B
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
  P7 a7 R6 `* L$ \6 ?1 b+ a: N% h/ H* h# C二、环境准备
# u7 ]8 x8 N& e9 v/ Z
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    6 g) h/ ?7 D3 h6 |5 J! r" d* x; r. \
三、开发者账号申请
) h7 V+ n% J/ s& w3 p7 W       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
# g8 E% a. C! l* E2 i1.注册并登录 Azure DevOps
8 N& j5 w/ D3 p8 i: H2.选择或者创建一个组织(new organization)。
" X0 q: k2 h! n" J3.在该组织下创建一个项目(new project)。
4 |; m' S+ J5 {$ F' ^4 |3 D3 Z. U2 v       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
4 b  T( X: M- X 1.jpg " S. k; q  Y; X, O9 k4 p5 R+ u
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。" G1 c4 c9 U8 O  E  _
2.jpg
* e# n+ b( r" D; V: z8 l5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。( p( v( R  [' Z* e' D
三、项目搭建8 L/ t/ k2 T" E1 L' W
1、项目初始化: J% @. k0 h# e
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    3 `" o7 O' p  X% I
3.jpg
  N7 n, P, v, Q# e  Z- k& O( l2、项目改造3 |  n" }! d8 T  t# N) t$ K
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:7 {4 F& o' m2 n( D. F: |
1.将package.json改造成以下模样:
$ e" ^, A  x( R
{
  "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包会失败。* h/ Z5 ]. X: q
3、编码
% K1 p3 E, d# v4 N. b! t/ s' k1 j: ^       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:) ^# h; d' r# S  b" c5 F
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
$ G4 Q6 }% V2 S! C4 `, z四、调试
% P+ X7 _  `/ M& f3 H6 d       单纯的开发代码片段的话测试和调试都非常简单:( k, S7 c4 e+ `7 L. z
  • 首先先自定义全局的code snippet。
    7 y' y# k  |( z% \& N6 S" k
4.jpg & O2 \& ?# `: ^2 d7 J6 i# l
  • 选择新建全局代码片段文件。
    + Z" f. c4 x' C3 l* q
5.jpg
+ }9 I/ F9 w' a7 w9 C) r' p- G
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。8 t- A7 h9 S) E$ h& p
6.jpg 7 m0 z, ^1 R( E3 f7 \5 J; J- r
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。( B5 y8 O3 k  i7 e* j: `  ^6 \. g" d
7.jpg
, C1 ~+ y0 q* C! `5 M' Q       生成的代码片段如下:
' s8 u( o2 L6 ?* _" g- _, n0 q$ G
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;
五、打包
/ n  n" ?# |" j1 u+ N* S       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。6 J* T# V, m; f
六、发布
4 Z9 [7 S' {! X       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!- I% n& o2 N6 b$ W5 x
8.jpg
( q) L0 [1 S/ @" Q       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
5 ?5 m/ a5 m+ m3 _' R, Y" \ 9.jpg
- g: p. ~9 ~, j- f' X! v七、结语/ t, c8 K- {1 c+ k4 m
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-27 04:23

Powered by paopaomj X3.5 © 2016-2025 sitemap

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