QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5246|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
( y8 [# u* Z  M5 O       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
$ [7 }7 M3 T1 K: ~! A; `二、环境准备* c" q$ R$ M8 e3 m5 d( |- B/ ]! p+ G7 r* S
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    9 h! d' i6 ]+ I( x# g
三、开发者账号申请; ]7 r/ _/ H0 z4 z% s, c% U: j0 `& a
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。% I, p& `0 O. K& n" O; n9 n
1.注册并登录 Azure DevOps
4 R5 t! i$ Q+ w. E2.选择或者创建一个组织(new organization)。5 e; r4 f1 {0 `/ y% s4 T) H  S/ ~2 S- q
3.在该组织下创建一个项目(new project)。
( W7 ^" a) D6 f' |       以上三步都是为了获取开发者(publisher)的token,获取token如下图:8 s, u6 I/ c' L- c( D; p9 m! J, m
1.jpg , P" b3 V1 ]1 u5 v0 b7 N
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
; }' P& m2 G" {4 ^1 ? 2.jpg
, K% F( @0 v! m0 I5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
7 V7 i* s7 g0 y6 ?三、项目搭建+ l' G! R# w* u+ M) D
1、项目初始化
* F- @; s) e2 \# ^, x4 c: ]
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。5 _# w7 k- ]* L& j9 z$ \# ^
3.jpg : e, x5 `, `6 w2 l0 Q# R% K
2、项目改造
! c+ O2 i/ V" ?; T: H# N+ N0 c       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
) ^9 }4 v) ?( l) v) n3 x; |9 z- s2 e' n1.将package.json改造成以下模样:
2 O' N  S. i: j6 o* r4 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包会失败。2 C/ L2 v2 M" N$ ~* W* }
3、编码6 e! D+ U  w$ {+ |, p! e/ i% v
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:9 H/ e& E7 s# K7 _% ~  F( `
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。, L1 [# l$ I: u- v6 Y
四、调试  H8 Q* i7 `( Z8 w! ~3 Y+ L, e8 ^
       单纯的开发代码片段的话测试和调试都非常简单:/ a7 l) K+ |7 Q1 T# C: B& {5 W- z
  • 首先先自定义全局的code snippet。
    ' O$ J, P* D! m$ \
4.jpg   ~7 p- o& j( V
  • 选择新建全局代码片段文件。
    . x( m3 r5 |" u
5.jpg
1 K6 P" b- i; d
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。7 `& o9 O% H* S+ _
6.jpg $ T3 ?& D- W: h" K6 x1 Q' O
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    9 e# t' ^/ r4 `2 G
7.jpg
' j7 ~3 ^" F" Q% r% t       生成的代码片段如下:# r+ ~# N) z# M6 v% W
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;
五、打包
/ j4 ?/ N( O' C9 N7 o6 U       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。3 j1 n6 m5 s5 U0 b- y
六、发布
& R& m: B6 M6 D/ {' Z# N7 z1 [       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!+ N& @7 e. n6 n; J5 g! c. X
8.jpg 4 ]/ Y7 @# n- a, K
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
; D5 Y% ^+ l: L" x 9.jpg ( d: q9 I4 i) i! U- M5 S
七、结语. ^$ u1 Y+ q0 A0 K+ M
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-8-8 10:52

Powered by paopaomj X3.5 © 2016-2025 sitemap

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