QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4249|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言2 G6 L, f$ }# [  V5 k- z% Z" c0 ?
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
% i7 ]. z% g  ^1 D; U  c( k; C二、环境准备+ s  t. N% ~. k; N3 \* n
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    ) x$ {! D" {% {3 e  E. @+ R
三、开发者账号申请
' s: T4 p) z( ^: q8 e       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
* t% y4 g! r# U: d9 {7 \2 y  A1.注册并登录 Azure DevOps
: c9 G! ^" d8 m+ z7 F0 r2.选择或者创建一个组织(new organization)。8 ^$ c3 l6 B" P( E/ Z1 G
3.在该组织下创建一个项目(new project)。
; ]& L2 a3 k4 ^( o7 e6 s/ ~4 P( {0 u       以上三步都是为了获取开发者(publisher)的token,获取token如下图:' }) p1 H+ x- I7 k' [6 S
1.jpg
4 h0 O) k' H1 [" L* Z3 K4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
  n8 l' r5 B; V; d2 @ 2.jpg
2 Q4 h# N/ Y  R# K+ e5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
4 a, _$ U" h1 m( H/ Q7 z7 N' k三、项目搭建
5 V6 K( Q  S2 Y: V1、项目初始化+ U; T6 H4 ^, F8 x3 |4 n( s
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。# [" F9 Y7 B$ j0 X2 w
3.jpg
0 i6 C7 Q2 S% a; |& [/ T7 B) h, z8 n2、项目改造; @# s8 F7 J" h$ v* ?9 D8 L
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
% H  f* l1 a" _, h* Q1.将package.json改造成以下模样:
9 o1 S* x5 s9 e7 G) ^1 p0 r
{
  "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包会失败。
+ F5 l, H. `9 M- N) ^' A+ w3、编码
& p1 L8 i" j, v. {; P  M8 v! h- h  j       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
1 \7 T8 f+ {( e. d! l
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
7 f; x$ Q/ [0 L5 n# y四、调试, U0 n/ F' \: w3 p& o
       单纯的开发代码片段的话测试和调试都非常简单:# S: f# z) y  [! X& H8 q% f+ ~6 d5 A
  • 首先先自定义全局的code snippet。( b- @" D! V  \2 @5 j
4.jpg % O0 `. K/ X- Y7 ^( }* w
  • 选择新建全局代码片段文件。7 l% V+ ~: r' b7 ?: Q
5.jpg
0 k- `' _7 F" {  o
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    * B9 q& s/ [" z
6.jpg
/ c5 u3 D  q7 a2 \
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。; @- e- E3 ~6 c; b* N5 X& p
7.jpg ( r# c& Q% r$ d0 z% b; i+ F
       生成的代码片段如下:
: X- [# ?2 \% f; U1 G
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;
五、打包
7 Z6 W; R" |+ b! @       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。3 W1 @1 X- M# q3 X1 s; @
六、发布
2 P0 `  k4 ^+ {       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
; }. C5 O' |; |4 z' C: A( R" R 8.jpg
+ w* o$ K* E. ^. i: p9 U, x: V2 B       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
' Q  q4 ^" X6 M) U( f5 |, v 9.jpg , n7 P7 N; K' \
七、结语& M' G) Y6 {+ S# s
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-27 19:35

Powered by paopaomj X3.5 © 2016-2025 sitemap

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