QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4188|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
9 W' W' W' o# Z/ N- I4 k       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。" J' }/ [% r: Q1 q% b. W
二、环境准备" D% Z1 K& @' P5 I' N! Q
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    3 l0 M* N" ^) w. I
三、开发者账号申请0 w; T8 F1 i/ q1 C+ z- b
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
' J  T$ s$ p6 _/ I1.注册并登录 Azure DevOps
+ J8 X1 ~& v6 D2 a/ B2.选择或者创建一个组织(new organization)。
* a1 x) M, M4 ?+ W( o! o9 k3.在该组织下创建一个项目(new project)。( A" F6 r# o2 V. w) L: F
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
$ x  R# p4 C6 j9 j' x& W 1.jpg : K: D- j3 O) j/ Z+ ]8 k1 r& u
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
. U5 U  E& X. h% J5 Q 2.jpg
; k1 s& i' z( d! E. j1 m! d5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。' O# t1 c( G* o5 U
三、项目搭建% I1 R0 V7 M4 I# u/ b
1、项目初始化
9 ^+ }" Y) @; _5 _
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。; Q: R1 S. @# }; }9 M# ^
3.jpg
' K4 N4 a2 z# c3 C& Z2、项目改造% o8 q) w" O0 p. \3 I5 @% g" H# w
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:3 J) n/ m! C0 Y: Z: S; H
1.将package.json改造成以下模样:8 m; X: w+ ?0 b  ~/ ]
{
  "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包会失败。& D1 B0 U5 d2 x( \# j* ^4 o/ k
3、编码' b$ p# F$ p7 ~9 h, @, S- O% X" }
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
0 }- u% q' T- P0 ?) w4 s& B$ Z! |
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
- [2 Q% k, j: l5 L6 m四、调试
: B* F; F/ \( J& J/ }; I       单纯的开发代码片段的话测试和调试都非常简单:0 s9 q; h' I5 I
  • 首先先自定义全局的code snippet。
    ' h6 }1 o/ W; _* Q# c" D
4.jpg
6 J, _- s) T1 z6 j" |  W
  • 选择新建全局代码片段文件。
    7 [8 U, |. s$ S: `4 z! E9 P" ^* M, l
5.jpg
7 E; h' q- C4 ~# c8 z7 `9 N
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    " f. N" m) d+ H+ J6 C& Z
6.jpg / x! I( a/ m/ w/ {) X
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    % L4 z$ Q0 M" N! y- T+ F- I
7.jpg - q0 W; ~( y; j" _; A$ Y! l
       生成的代码片段如下:
+ L& @$ H6 G. ?& r2 [
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;
五、打包) J; p( O: p2 H/ ]/ t
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。$ l3 d1 p" P/ I: y5 `
六、发布
. J( i8 O, I6 ?7 |: ]       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
0 G8 G; f. G4 ?, V& {- C7 ` 8.jpg
2 S. ?9 q& N2 q5 n1 Y       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~  L# s$ G/ Q) v: a
9.jpg
9 b: ^3 q) p# A/ e4 l* C七、结语
0 R* X8 S0 _* n- E       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-16 05:03

Powered by paopaomj X3.5 © 2016-2025 sitemap

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