QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4369|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
; e- M# ]1 Q; v: n2 e       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
+ M- b* b+ N, b. a6 _8 I4 g" D二、环境准备5 z0 E8 z, A+ z: W' c- D( A- A
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    & ^/ S2 U8 K9 F5 `6 _  b# ^" O0 u
三、开发者账号申请9 g6 L7 ?, V+ s9 I# S+ v
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
4 c  j0 \  n6 Q  O1.注册并登录 Azure DevOps$ o% t8 _% E  m( e6 H: s# v7 Q7 u
2.选择或者创建一个组织(new organization)。
# O  q# u; }0 |4 X3.在该组织下创建一个项目(new project)。: R( x: P0 T: [: ]
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:. J3 R2 X+ M8 F6 ?% y  T
1.jpg
/ f, p( d1 B' B0 o4 J& k! a4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
$ h3 X. c) q' s( F+ h6 u& [8 C; W0 L 2.jpg . J% v* ~6 i5 M' W9 [
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。: u( Q% `5 I4 {0 r- w
三、项目搭建
: Z" f* `/ _; J- F4 Y* C6 o; D1、项目初始化
; \. f$ [; \0 {+ I  j* h! w& J
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。  q7 j- ^1 v: s1 L- [" D5 T
3.jpg
8 \" W/ i+ o) X  l1 s2、项目改造( D- ^, ]" F, M0 l9 ~
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
* V, B9 f" J' r+ A1.将package.json改造成以下模样:1 Y2 |+ t* n5 U6 Z6 L
{
  "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包会失败。' p, X% R* a1 M, v" \
3、编码# ~3 v1 F( w3 V  M: }
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
, J; P- b! g' C$ P
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。0 N$ @0 t, [9 V% g9 |: N
四、调试
! O1 l6 X% _. S: ^0 Z0 l7 m       单纯的开发代码片段的话测试和调试都非常简单:
  |$ c9 q! x% \$ X" S6 b5 g7 }
  • 首先先自定义全局的code snippet。
    8 n* Q) P! @( k
4.jpg 3 \# R  I2 m9 B) Q0 _
  • 选择新建全局代码片段文件。) b7 R% O' ^8 v3 Y
5.jpg
. e& n2 x, G" z/ R9 W
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    7 C) Q3 h# }: l- Q# q  D% u, G+ e
6.jpg
" m6 T( |1 m6 r; _: a
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    0 W# k5 O: F  `3 L  Z" w7 d
7.jpg + ~. @/ F+ X, P; Q  [7 y2 Q4 y
       生成的代码片段如下:, \# }2 P! E4 @3 D0 J7 `
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 p) u8 Q8 K! A' V4 P* \& l1 R9 g       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。) n( B9 }1 E6 D# f1 ^' ^
六、发布' ]4 v. ?' G" _; @7 D6 @8 p0 c  u* r
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!, ^( i8 ^& ~  E" a1 @1 U& L3 H
8.jpg
  R$ B+ s$ F( c8 }, P/ b8 g7 ^1 M       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~9 G3 `" @1 Z' v9 o9 n( \# `
9.jpg
+ R1 ]4 o  f1 E  d3 o9 Q6 }七、结语0 ~$ ]9 `3 p5 {! |
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-3-7 07:08

Powered by paopaomj X3.5 © 2016-2025 sitemap

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