QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5118|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
1 |  c8 Z( K- a( `$ Q! ^       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
9 k% ]: J* O. Q- n9 s, Q7 p二、环境准备* L% V( ^) P( f4 n( q( ?
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    + s' d9 W: H2 x6 e( }5 K
三、开发者账号申请" l; h6 v2 H/ R8 U% u# c
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。3 W# ~( V" ]& T
1.注册并登录 Azure DevOps# P0 W9 Z8 F( k2 g
2.选择或者创建一个组织(new organization)。3 E0 `4 P' O; e. \
3.在该组织下创建一个项目(new project)。5 @$ a3 @7 Y  m  M
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:4 L9 Z! m* V  h
1.jpg 6 ?8 W  v3 v% j  O8 ^; l. L
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
" M4 R. k! L5 { 2.jpg
6 u" T3 q. C$ g% z! ^* o% O7 G% e5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
: b, ?+ |" X  v三、项目搭建' Z2 {0 @: k* L# B
1、项目初始化
; T" i! Z# V0 i
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。) ]3 {% i. m4 h, U% }4 P
3.jpg ( a  _- @3 i7 V  d
2、项目改造: G- a) A, u# d- ]
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
+ `, ?$ M/ A) o/ B3 [, Y1.将package.json改造成以下模样:# s7 S+ V- P% R' N) W2 `+ H, ?
{
  "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包会失败。! `! o; G, H# z; i9 w
3、编码2 v' Q, m8 A( j( k  u; O! a1 h
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
/ V8 O5 v  @" a( E% N# @
{
  "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, f4 ?& G/ }& c' W- _7 w
四、调试
% }" {! H/ s, @/ M& |1 j! z( k# y+ X- ]       单纯的开发代码片段的话测试和调试都非常简单:
6 c& l- t" r2 C; ?- N8 C; x
  • 首先先自定义全局的code snippet。
    : N+ e; \% G2 ]$ [" K# A0 E
4.jpg 6 a6 S/ B- T$ K+ y
  • 选择新建全局代码片段文件。9 n2 W$ c  Q  A5 \1 B4 b
5.jpg
( l! d; v8 {. A
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。/ X1 K& k6 ~! y- i+ j% F
6.jpg ( R3 m/ n4 I0 j' E# h* ?" b
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    8 ?9 [% }; Y$ w$ y1 k1 w# i" A
7.jpg / s9 k. @+ I$ E% a+ J
       生成的代码片段如下:# Q. s0 Q- T$ J
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;
五、打包
; M; D# f4 O8 V. }( }) u       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
5 l* O! [$ q) v2 V5 E" i1 k3 G- g六、发布
! B0 D" l$ N. u9 g* S& i       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!/ i! m! ~# Z, x& i/ w' d. o* x: T
8.jpg
0 ?+ S6 i" S" X, |' J       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~9 C/ a; f; r2 L, N, ]: f
9.jpg # V+ C. b# [4 S  _; t8 S
七、结语! e7 y5 w8 R; m4 M2 _- b
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-20 12:32

Powered by paopaomj X3.5 © 2016-2025 sitemap

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