QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4071|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
& c9 W; u# ~' h& D       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
% t- K9 n- M0 n; e) d2 R二、环境准备4 j0 @; F& p& s$ D; W/ s
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    : J' q* z: r$ d+ F! ]( m
三、开发者账号申请# [1 Y1 J4 A- [
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
* y7 V/ K+ ^" [# y0 S, d1.注册并登录 Azure DevOps
2 \% I% o2 h  i% r: S. j2.选择或者创建一个组织(new organization)。
" R  a- f$ k8 s) z3.在该组织下创建一个项目(new project)。7 n6 ?; q: }/ T( b" @
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:5 ]- O; C% @, ~' _
1.jpg
, L; u' I4 N5 T$ I2 V- R2 k/ h4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
; [/ C6 j2 k% `% c% j8 t1 `3 ] 2.jpg
7 h( }( Q; Z8 m' v+ ]" D. j6 k5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
8 ]  G! k" B: @6 a/ T+ t2 X三、项目搭建  I2 F8 j# w4 I8 [( {( n+ {- T* [
1、项目初始化
' y( `1 G: G/ B4 V; J4 `' r  s
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    : D& Q; N  i$ J) W0 M: b0 e# D
3.jpg
# o- A/ j0 C( d. L0 u) ~2、项目改造6 C  h% A$ F/ x4 i$ k
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:( ^( \/ `; k" [0 w* j  T) G% ]
1.将package.json改造成以下模样:  D  @! d5 E( c( r8 _  j6 O6 b3 j
{
  "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包会失败。1 r; i0 Q# r; w1 F. q+ d
3、编码
0 a0 z6 ]# j3 X6 g3 \3 y8 b1 O       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:# B5 l: C3 S% u9 R2 G
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
% A# w2 f$ h- E) c四、调试
( i. l+ o2 }' T3 i       单纯的开发代码片段的话测试和调试都非常简单:. V! m. K  [2 O" h6 [( K4 {8 a) Q
  • 首先先自定义全局的code snippet。
    0 m& m" A3 |6 _. z" Y( X- i0 C) G
4.jpg $ T( |1 `, K. ~
  • 选择新建全局代码片段文件。6 c% \* q7 f+ _& }* M8 ?
5.jpg 5 t8 ^  i( u6 G- ^8 s
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。. N, {7 A3 D, m9 u! H  r: Q( ^
6.jpg
% {4 I% q9 T: r0 i) M
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    6 @! p3 p( g# H, {
7.jpg
' \# H; U, t8 j3 `2 F; y# H3 H       生成的代码片段如下:6 h1 N* P" }: 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;
五、打包
8 G# S6 N2 e% N$ F/ B9 L- o       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
" C$ F; s% J( Y5 H( D六、发布
7 _7 E( \( }+ @8 I% ?       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!4 {+ x9 @, w3 p5 y% G
8.jpg 5 b% @, v2 T% W' z
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~! l' Y5 z' w& F2 n" p
9.jpg
1 W" V  p3 \- q+ l# F# \七、结语/ P8 j, y* Y9 g6 L0 f2 }) |4 v# [; O7 b
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2025-11-24 20:50

Powered by paopaomj X3.5 © 2016-2025 sitemap

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