QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4212|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
+ N* C& w! T0 S3 ~4 J       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。7 M5 z5 [$ m; B0 ^
二、环境准备" X! z/ W' S9 V/ v' ^4 l
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g3 L: ^0 Y% B6 P/ J4 V( _
三、开发者账号申请: u3 a% J% D" g) ^
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
. ?! `' r  P7 b9 G& F3 V1.注册并登录 Azure DevOps+ A, D) \; g+ k9 v
2.选择或者创建一个组织(new organization)。
- Y0 _3 K- P4 a, L3.在该组织下创建一个项目(new project)。
9 y  H* X& q0 Q       以上三步都是为了获取开发者(publisher)的token,获取token如下图:2 a1 H- o9 ?) X; j
1.jpg
5 [* a% u$ Y1 \( D8 N# X4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。  Z" b; x1 O8 p  [- V8 Q2 }' F" z
2.jpg 3 `  c6 M- d4 k; `# C5 x
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
; x1 S2 R2 N) w2 Z" u. E三、项目搭建9 O8 l$ N' X8 V: f6 F# c% J# t
1、项目初始化0 f2 b9 j0 j) N
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。2 z$ r( d# h- x1 _
3.jpg   _1 v* X3 K' N5 M" P+ x% s
2、项目改造  O4 \9 ]" K' F1 B# A5 G
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
: [+ G# d+ z4 v4 m& ^1.将package.json改造成以下模样:! ^. r" U" W, m
{
  "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包会失败。& x$ F" L& z2 Z* F8 g6 Q5 t' U
3、编码! e* ~6 ^7 t6 Q. L$ O
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:  G  X% O9 c6 r* U7 d) o* P& w$ k
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
9 o& e4 ?: E' _6 ?四、调试: K( t0 W: i( M8 e, {. b6 v& y
       单纯的开发代码片段的话测试和调试都非常简单:
8 ^0 f4 k1 ?7 h  X1 N; b
  • 首先先自定义全局的code snippet。
    / S8 u: Q, a, `/ I, @4 M
4.jpg
; g* ~' V) o% g) r
  • 选择新建全局代码片段文件。7 j0 L$ B- U8 h% ~5 J
5.jpg
; p, u6 o7 w; D& M- z' ~
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。9 Y' B) v' p1 j- ^9 M! i* N
6.jpg
) k( g9 s9 j" Y2 H9 S& X/ Y; T
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    $ H- E5 B& q. e* z9 X
7.jpg ( r* G  W9 m% L3 K7 C: e( b
       生成的代码片段如下:
1 k  M: Q3 c( Y5 C0 H4 k/ F
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;
五、打包. \3 N" n+ g3 N9 h9 D
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。& L# c+ m- M- y$ d  Y5 C
六、发布, k6 @: [8 ]/ e8 }# H
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!9 n/ H& t: S& c# v0 g3 Y% O
8.jpg # Z% L, k, {; k3 F* V2 C
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
, A/ |5 `- ?: [9 `. d 9.jpg
3 ~  a. G# B1 Y+ Y七、结语
9 L. K( H; E0 c( k5 G; X       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-20 00:22

Powered by paopaomj X3.5 © 2016-2025 sitemap

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