QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4672|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
$ X" x: D$ [9 I/ x8 d       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。8 k# b6 G6 G5 d: D
二、环境准备
" D6 {) ]) u8 _4 B3 k' {
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    6 h% T: y0 O: N# K% H3 l( t
三、开发者账号申请
- T# p& K6 R/ ^1 C" M4 a       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
# i0 h; H% Y- I0 @( Q4 e1.注册并登录 Azure DevOps
9 w8 h7 Q$ ~9 |" M2.选择或者创建一个组织(new organization)。
0 O+ J- @$ G, ^* u* ~3.在该组织下创建一个项目(new project)。
# ^- m( U$ f8 [- i, p0 L8 f       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
  @: f5 o% p; p+ `$ {+ d2 M 1.jpg ; r; a" Z2 Z/ j- I$ V. z
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。6 z& h# `4 l8 \2 ]  q
2.jpg
0 |# F+ W9 D; B, b& e# K7 r4 N$ d5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。! o( \# M* t$ o% H+ H. `' j
三、项目搭建
: p8 C! n/ y0 A( Q' b0 Q/ m1、项目初始化# m4 \% G( V( j! F& j, B
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    , H, |- c# t1 \- p( f* z' ]
3.jpg ; b4 {& b! d& A4 V
2、项目改造& I8 U  v4 `3 U. T
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
9 A$ O+ Q, y+ P0 @1.将package.json改造成以下模样:
* U, r. g3 ~# z5 u- @% |
{
  "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包会失败。
0 H" h: W9 I3 g2 j3、编码
) i0 o$ A! B4 j8 e/ Q3 X& ^8 q! r' Q       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
, A1 u+ E2 B! [3 q( ]( }: x
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
' C( u4 h( v% G四、调试* o$ R$ b( S( i. i
       单纯的开发代码片段的话测试和调试都非常简单:1 E8 e8 s0 ]; K3 P) K5 Z
  • 首先先自定义全局的code snippet。
    : q! Q/ A4 \5 e4 m8 b
4.jpg
$ K, E5 ~, c0 S9 ~7 y7 ~) B
  • 选择新建全局代码片段文件。
    3 V% {- B, m! c5 `  H9 g" D
5.jpg
9 A- f) O% d2 h! {  S7 }. ]
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    & {0 b1 W4 I- H0 k7 K7 |/ i2 l9 H3 g
6.jpg + r( q2 d. ]/ y& i: G: m6 z* v
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。5 y% T5 b* M* \0 a2 V  A, s6 X! ]
7.jpg
1 {# @8 _1 q$ x# M7 E       生成的代码片段如下:
, E- W8 z+ P1 u8 y: l2 S3 {0 ]
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;
五、打包
( d% B* I/ ~' Z6 O) Z- n       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
% c6 n" l- a, I( N$ y4 U9 G六、发布
' B; H' d! n, x; m- s. a1 _       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!9 i5 j3 X) Y3 L. {  U) c' b
8.jpg
0 j: ]' }$ b* P; B+ R       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~5 l3 _4 H6 f7 V9 k% w+ l
9.jpg * N6 l7 x8 O1 M0 L$ m2 `
七、结语
- Z4 g9 ?1 [9 W( E  j" a4 D3 y       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-2 17:35

Powered by paopaomj X3.5 © 2016-2025 sitemap

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