QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4233|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言; l" {! y$ m# w5 ~" K& K
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。& T; c8 H* g9 S* J+ x7 Q
二、环境准备
% _: g. e6 `; H. @
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    - f. _0 W- V% z2 U  h0 h2 R! D
三、开发者账号申请
( I3 O! M9 y8 j: z& k, |8 G       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。- v7 k* S' v- ]) e' ?
1.注册并登录 Azure DevOps
, O  O( d5 ?& i  Z# I2.选择或者创建一个组织(new organization)。
* q2 b$ V# x" b4 b; S3.在该组织下创建一个项目(new project)。2 |1 M# \. O0 s7 n
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:  k7 L( D+ [8 ~% ]  O8 `
1.jpg
4 H0 v6 ]3 R! s, P, X4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。: f4 d3 Y" I2 p; g. p3 |6 @: M
2.jpg 7 W# X4 {3 u0 J( y1 E+ |. P. Y
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
, W- l( u3 _9 b8 s0 E! ^三、项目搭建6 P4 h7 C7 ~* W
1、项目初始化
0 N9 E- Y6 d3 S: l, m6 w
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    * N' v" u. b* b, h% d6 ~9 g
3.jpg
1 Q7 ~  u. w$ J6 Y8 d& I2、项目改造+ R. H: {& o' p3 J2 v& K6 f: D
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
) x. A0 K, D& N) B1 j% a# `% D1.将package.json改造成以下模样:
/ O' \3 g9 r% f
{
  "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 U: Z3 Z% y
3、编码- n* `- T  J* g2 V2 F0 E
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:- p" s: S+ A" Q- v( m1 D. m4 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。: [0 d" b8 f' W: [0 S  \; u& O% P
四、调试6 G2 \7 G7 t# ]
       单纯的开发代码片段的话测试和调试都非常简单:( i; p7 j3 D( E/ f
  • 首先先自定义全局的code snippet。7 H+ p, r/ j/ D" A" O  N  g2 {
4.jpg - n. {+ D2 [# N( O; n8 ]4 q. i
  • 选择新建全局代码片段文件。
      A) b7 q" c' ^. _: Q6 \- N$ o
5.jpg ! T, R' D4 o$ ~
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。& ~& P5 }* a9 [& U3 H' y4 r2 e  q& g
6.jpg - g& j' i3 N. @* O; _( R
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。, W$ D% E( {4 f1 ^
7.jpg
: X  A+ u! ^( N4 w       生成的代码片段如下:% Y7 H: A: s9 u8 Q: S8 t" p& }0 f
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% H7 X% o! [, g0 u2 |
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
( t% k- @* d! H( y; n, o; k8 c9 o六、发布
8 i- J4 l4 S" M/ `4 n+ G       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
8 q3 p( O3 H6 Y. m 8.jpg
7 n0 Z4 a. P3 s- z0 ]       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~- ?) z5 r3 D; f  \+ @0 H' G
9.jpg 2 K+ ]7 [3 C  @8 a* E+ n6 K
七、结语7 b! j9 w4 y6 G2 E" a2 N  s
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-23 19:42

Powered by paopaomj X3.5 © 2016-2025 sitemap

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