QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4541|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
: T2 p# u# p( k  H2 v       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。* E$ M8 W% s. N
二、环境准备
, _- r8 H9 y0 p8 L
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g$ E5 I1 v0 R7 d5 H
三、开发者账号申请
. y+ T3 P4 x! m  e/ d# F" {       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
+ u+ r& |  H' i1 G& e1.注册并登录 Azure DevOps2 e; X% S  ~0 X
2.选择或者创建一个组织(new organization)。
; `0 O1 L9 _9 A: [* Q$ @3.在该组织下创建一个项目(new project)。" x3 N) v1 d1 q, A" q: [' I8 f: `
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
% z  M4 A1 e' ]3 U 1.jpg # h- ^& k$ u) E& A
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
; i0 W% D* `# y2 k$ f" \ 2.jpg * f6 J: _' K1 v9 B4 r4 H
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。8 M0 a5 a  Z3 d# [! V
三、项目搭建
! Q/ p- d$ I0 A7 f5 x1、项目初始化1 p! N* I: K! k0 A- ^4 I
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。( ?4 ^( [+ j) q5 x
3.jpg
# l$ [: w4 ]7 K! z9 P1 Q3 K2、项目改造. g0 Q( t: o# l+ N5 h
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
+ O. Y  E3 E% V* m8 n8 G  @1.将package.json改造成以下模样:
; C- h# s% V' ?: g
{
  "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包会失败。
+ ]$ g( x% J. V( I8 O% v( d! U3、编码
! i; j# t6 V$ k  ~       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:5 E! Y8 K6 x# f' S- A
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
( ~% O8 M/ C! k0 F) r. F9 B6 F! l四、调试. G# V! j" i: x6 t, S! w
       单纯的开发代码片段的话测试和调试都非常简单:
  Q& g2 s* E  R7 p# t
  • 首先先自定义全局的code snippet。
    6 K+ k; m9 H$ q9 n" y# B
4.jpg
. k" p7 D; C, Q* n. p) U
  • 选择新建全局代码片段文件。* S8 e! Y3 i6 Q& z& B3 J
5.jpg # w- {! M, w/ w) f
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    ; W7 }. p0 j, A0 Z' h
6.jpg & x+ `5 D  o6 e7 ]: Q, Q( ?
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。  n3 A" V4 h2 h8 T
7.jpg
5 |) r8 A( p/ r- Y       生成的代码片段如下:
9 |' f: Y3 }. ?/ E" [! s/ c, L
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+ ?  d% Z$ ^0 e. v4 s6 j6 r
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
9 v# d3 y/ m! ^, ~/ x# J六、发布
4 }5 y- b8 l5 l       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
1 ?& ~, I4 R9 t1 E! R 8.jpg : x# H- m, p1 o. l7 T2 y7 W
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
" F# o, g$ w' Z) _, A, A 9.jpg 2 x& ~1 N. t1 ]0 g' L. T' Y6 Z
七、结语
2 z. h2 w: ~: G7 s( T6 r9 b       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-4 13:54

Powered by paopaomj X3.5 © 2016-2025 sitemap

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