QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4171|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言4 F. m$ l4 A2 R% d7 c
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
$ P: C; v0 @5 q' x  z/ z二、环境准备
2 A+ ~( u3 Y- d6 G2 [. l
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    5 ~" H9 \- D8 }
三、开发者账号申请
* e! }& U# _3 r9 i: J       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。9 V6 i- z( E# X; ^7 G
1.注册并登录 Azure DevOps
$ X* G- G7 y  }# l/ H: a/ \. p5 K2.选择或者创建一个组织(new organization)。! j" K# B- m" x  c/ s. n
3.在该组织下创建一个项目(new project)。
9 n6 D% u5 b. \' d1 O+ K       以上三步都是为了获取开发者(publisher)的token,获取token如下图:$ @2 o$ y9 [+ q$ T) m5 e# C
1.jpg   c. t8 \3 z8 ~, X0 A
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。! c* C: O* o8 u3 n
2.jpg
6 C4 x( P) P( ^$ g( [5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。/ J" t) S7 h  W: O4 A) g: Y
三、项目搭建
# I( e" w& {3 ?! y" \1、项目初始化7 J' h6 C# n1 [+ T
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。% Q7 \1 E& |7 C$ w7 v
3.jpg 8 y0 X$ q$ i5 M- R) b
2、项目改造
3 T- C* F  }5 i) N       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:6 w3 z% c- N* t. Y
1.将package.json改造成以下模样:( e' m0 p. }- T' x+ g- }
{
  "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包会失败。
) k3 t- V* x# C  B3、编码: `  A* @) a  P6 {
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:6 `/ f7 j' h  j
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。% Q% [0 w" v9 |) q
四、调试
1 R" g, l; [# E: e0 h       单纯的开发代码片段的话测试和调试都非常简单:
2 f6 b& d6 a- P
  • 首先先自定义全局的code snippet。
    & t2 E  i5 G3 n" v: H5 y8 [8 C
4.jpg ) I* L7 a% d+ w. E# X8 f) n9 j
  • 选择新建全局代码片段文件。
    # ^* I# s. U' j
5.jpg
% c- E/ V. I' v
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。$ _, Q& C/ Y4 N5 o9 l
6.jpg - }' B. d6 `, @: D: O* l& f- I
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    ! s1 S% y4 x- n0 U
7.jpg
" F( ?2 c& g+ r4 T2 }0 A- C  A       生成的代码片段如下:8 K) e- M# N; u( B. Z2 C
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;
五、打包( s: F; Y  S3 t5 m" O
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。% l9 b+ w8 A3 c3 `( O" f
六、发布
$ j% U7 d( O2 _* r2 c       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
+ v+ l) O6 F/ E" b$ k! Q2 c 8.jpg
' G$ A3 H* s) ?$ h2 S       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
$ L4 U0 E, {* O- e  M  H 9.jpg
1 |7 d8 ~5 b! ?: ~$ e+ v( L3 Z/ x4 {七、结语, p. e' s9 }+ `% T# C
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-13 11:28

Powered by paopaomj X3.5 © 2016-2025 sitemap

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