QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5192|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言3 Y8 U& h8 i% W" W. t
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
: }. y5 y8 t; V3 f5 w二、环境准备( `/ j3 K5 l, H/ P$ b( N7 j4 J3 R
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    8 L( q1 T' i( T' ]6 L. x$ P
三、开发者账号申请' j* b5 [$ I* W+ H# g
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
3 x9 B: |0 P8 I# j' k) M9 E1.注册并登录 Azure DevOps6 [4 `5 D- G+ ^3 r# t9 n
2.选择或者创建一个组织(new organization)。
8 e* P6 t7 }1 g- S6 ?4 a9 j2 V3 M9 }+ R3.在该组织下创建一个项目(new project)。" M) i3 V7 I# Q* C
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
: l5 v4 S- i7 U3 K5 _! G 1.jpg & b$ _3 O: G$ l5 {; I' ^$ Q8 M8 ?
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
. f& Y2 k- O! P 2.jpg
9 t5 ?' W$ D8 `8 p$ K5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。5 ^$ B$ y0 O/ z; A# n; t& D& P
三、项目搭建
' r. q# C. o8 H9 L# N1、项目初始化
2 N% F$ G4 x$ v* j
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    7 Q7 t" q1 V- P+ B% I2 B- m
3.jpg + g. }2 L- q* j
2、项目改造
/ C& }4 A, t  x* h' e# p       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:4 k% J7 i, @! a9 Y, U+ N
1.将package.json改造成以下模样:
( ~/ X! g% P. _2 f& |+ {3 d
{
  "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包会失败。
6 p! G; U. ~( o8 `3、编码% @5 \) W$ e0 m6 n5 D
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
( N, ~$ m1 E9 K+ Y. I! M) R
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。6 q7 l3 e$ @0 f  v
四、调试
1 s" K9 o7 Q# C7 D* Q6 l/ s       单纯的开发代码片段的话测试和调试都非常简单:
' L  F$ x; e2 I3 @( f8 Q8 U) q5 `
  • 首先先自定义全局的code snippet。: q. ~. Z$ n6 w0 L" m+ Z0 @
4.jpg
$ Z0 l) s2 h$ ]7 l
  • 选择新建全局代码片段文件。; m9 F3 C% l4 X* j) c2 g( W) m: O
5.jpg
" f7 i2 K6 _5 B) [0 Z  s  n- g
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。' M1 {, f( t4 V: s' v0 G2 }
6.jpg 7 Y4 r5 a9 w1 m5 ]7 E( g
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。! G% Z+ F# \0 N) C/ D
7.jpg
2 h& I# K: \& C# K: Z6 Q       生成的代码片段如下:
9 d, Q% z/ i  K
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;
五、打包9 K# `! u1 L+ t' q2 M' _/ j
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
  d# k0 u9 y$ n, P6 f$ I* |六、发布/ y7 F' y2 t" J. Z3 ?$ K/ i* l9 a
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!/ x) k! |' P% z+ M% }7 B5 v! s
8.jpg
; `: N3 B4 F& l( m+ j       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
0 P" g5 Y) j1 s9 ?$ P9 O/ t8 \ 9.jpg
& g2 x' D: P7 l( X, ^  i& o七、结语/ ?! C/ E! \! S6 T" f% V7 G
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-31 02:55

Powered by paopaomj X3.5 © 2016-2025 sitemap

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