QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4551|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言& X, G( o/ {7 `
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。1 m( k! r" D# v0 {+ H9 P" p* j* K
二、环境准备( I$ _0 t: T0 m1 X4 s7 L8 D
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    0 H* H9 A( \0 a( |3 H
三、开发者账号申请
! C) n- z% v: B& Q8 Z6 T       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
8 B) n, Z7 E: F" B" U7 e" y7 r+ L1.注册并登录 Azure DevOps
/ @- J* _* q5 g: ^6 ^6 k. \2.选择或者创建一个组织(new organization)。, A. `& G3 ?8 P/ p6 K9 W5 f
3.在该组织下创建一个项目(new project)。) W4 U( n  \3 L$ j7 ?+ ]
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
, Q/ ^9 x) {' {! l. z4 p 1.jpg 2 c# W- E; I, S8 n; d4 Z) h& }5 x
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。$ W, M' B" S2 F( M  v6 a# T* @
2.jpg
$ e/ x4 u* ~, `8 o; g, N* p5 J5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
& ?/ y+ ]8 J: ~: ~7 x# x% d三、项目搭建$ Q$ n& a9 F6 l0 ^
1、项目初始化
2 z4 ?* q* T" h
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。! u8 v, {) Q: t
3.jpg 6 P7 R9 C+ `: C( x& ~% W- L
2、项目改造! y) }% ?2 _7 I- {+ |" K+ n
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:7 e7 m% m) B! P9 d; s
1.将package.json改造成以下模样:
# |1 u+ T* X% Z  {- w. [$ @
{
  "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包会失败。) h, B  s) J# {3 ^0 q2 x' B3 D  u' m9 S
3、编码$ l0 I8 {2 v) S, j* P
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
" k0 j. M/ r) r4 B8 w/ M( Y# k/ J( ^
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
: e) [5 @# B( ~; n" M* ?四、调试  p: C* q' E' \8 l- X: @. n
       单纯的开发代码片段的话测试和调试都非常简单:: g  G0 U; t0 A9 h
  • 首先先自定义全局的code snippet。
    % c/ o6 `- P/ Z8 @8 v
4.jpg " v5 I1 k$ {/ J* g4 y) {' W
  • 选择新建全局代码片段文件。! o2 d; e$ n$ o8 x+ f3 ^" x
5.jpg ; i4 |* a1 R- q! T) B
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    * t8 m% M; x2 m' t; {
6.jpg % ], V2 x8 j8 B, t
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。* ^5 `3 j* o' G4 N
7.jpg
( B4 L) K8 s* `* d. b) j       生成的代码片段如下:2 n1 c) p) a$ I* `' }
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;
五、打包* i$ H+ @# O( ~) @7 C* U
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
+ a( C* }) G: O1 m7 f. [% U/ i六、发布" D* ^( ?0 F7 a: T, V2 u5 }
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
* V. L; t' N, K4 N$ K8 o8 E4 B. s3 P 8.jpg
# E& D0 |( l* h5 M- C( W- [: B. \       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
7 Y; z1 ?# F1 y! S 9.jpg
/ k. C: B  ]: B/ `! N2 s+ m) A七、结语9 m/ b9 `3 Z) c* \
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-7 05:41

Powered by paopaomj X3.5 © 2016-2025 sitemap

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