QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5135|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
" y5 X7 I: C$ U       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
3 d0 D7 ?2 y; u6 I& A二、环境准备
6 A+ l5 s! x. R5 d8 A3 l
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g+ a4 Z1 v/ H5 x2 h: U7 P/ C
三、开发者账号申请% M  k; }" o$ U7 z3 E, g
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
1 d# }: z0 f. ]2 ~' c! |- c1.注册并登录 Azure DevOps
! P$ {5 {& J# @9 ]- m5 u% J0 G2.选择或者创建一个组织(new organization)。* w; B0 ~$ P# H% P9 C- \- }- B
3.在该组织下创建一个项目(new project)。
, O: g1 Z1 U' M7 G: D" l6 W       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
' j- |' H9 Z( ]- q5 W" r 1.jpg
1 g) n# e) ?% T" |2 G6 X! H2 o4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
$ o2 O9 b# a2 h2 B* } 2.jpg
; f( N4 w" @3 x" B) u% `  `/ L; ]' t5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。- U6 ^  h2 Z2 H5 q: ^+ o7 u
三、项目搭建, G2 f# @- q: V" U/ a. v  L# \
1、项目初始化
0 L+ p$ Z! T5 l0 i' K
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。) u, u+ j9 c3 g  g8 ]! t
3.jpg ; ~6 l8 s) d5 y/ G  `& d. C( @
2、项目改造$ n7 l4 {# k7 j$ H* _
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
8 g6 A/ Y( E% r* V! i/ Z1.将package.json改造成以下模样:- i' h2 E, [' P5 j6 c
{
  "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包会失败。; r# n4 ]- c% t# u" f, ~; A7 w, R
3、编码
, u! u; v* x+ }6 L* x       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
5 x% Y% D; F, ]! q# m" V: i
{
  "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  D; d  Y- F) B6 I
四、调试; t1 y; d; S5 A; a
       单纯的开发代码片段的话测试和调试都非常简单:+ x2 [. d) Y! W7 g* v* p- n
  • 首先先自定义全局的code snippet。% n3 l3 h+ `; k. e4 ^5 @# z% b
4.jpg
3 i$ ?8 D9 |  }- K
  • 选择新建全局代码片段文件。- `8 ?" l! a4 x, g3 O' [7 R4 u! n
5.jpg 0 v( x. J1 l" W1 K; u
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。% b0 J9 {6 ?8 U% Z# P% t% U- b! G
6.jpg
8 \0 X: s! Z- `  g0 f, W
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。: f9 P/ C1 a4 c) ~: Y* f+ W( q. t" U
7.jpg
; c, f6 X+ ]6 a9 h1 |0 P) j' [       生成的代码片段如下:
' Y& f6 p% J* f6 J2 ]) e# O- @6 l& D
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;
五、打包# |. f  E& D/ K
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。7 X% g8 z5 d6 c
六、发布
. V8 \0 A. [" m4 _3 h       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
6 c5 G5 H8 w; O5 e& b) g) U3 I) u 8.jpg
4 s, ^% c" Y7 w       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
8 }+ ]3 U7 v( b  e6 ^0 `5 C3 s 9.jpg
, p5 h+ j1 f& L2 |" }5 t) A: g七、结语) V- P9 @1 a( Q- c. L# l; B
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-22 21:56

Powered by paopaomj X3.5 © 2016-2025 sitemap

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