QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4357|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言& F9 c1 o& a' P2 y$ R0 w/ s0 K
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
: c, z: u/ D2 B: [6 x1 B3 P二、环境准备/ t% \: L7 z( Q2 l! V
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g/ r" {1 \8 ~) ^; C
三、开发者账号申请
) G8 l, L5 |: b: m+ ~( I       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
- D) j, A  u( U: F! M4 x7 |1 Y1.注册并登录 Azure DevOps( N( V. e2 q" U1 J* c0 J+ y) O
2.选择或者创建一个组织(new organization)。# ^( C. q& u7 B# E3 ]
3.在该组织下创建一个项目(new project)。
) ?5 h+ _% r" L+ E/ `0 E       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
) g0 u- @: R7 H# h, | 1.jpg ( R6 O% `! j0 ~* Z6 I( H6 s
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。! l5 y: ]1 d+ T4 k& r4 w6 r
2.jpg
! N( e, r: I' y! T  n: v5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。0 E  x+ J% z) t% S
三、项目搭建
( o  I3 M$ _- D# n' q1、项目初始化
* f% t6 T* ]* g) c' [/ B
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    : C7 C; |) p% H+ L
3.jpg & z5 p3 Y6 ]& C) G9 L* q* A( T
2、项目改造4 Q+ K! Y' Z) F- G1 v
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:+ b" [% R( }# B2 k
1.将package.json改造成以下模样:
1 `! `! R! R5 i, g" N9 o
{
  "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/ ?# Q5 @* i9 b3、编码
# b6 n0 z. C: m% R- B- [2 i       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:, x0 e9 n- n( j; y8 f6 m
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。1 N/ {- n/ y' H8 U
四、调试
. g# U# i% K% @5 n: j       单纯的开发代码片段的话测试和调试都非常简单:
. |3 g$ v  K6 n- O( o4 y
  • 首先先自定义全局的code snippet。% x; v& w' _/ f* E5 O$ v6 G. f" r
4.jpg
; t. m$ i# Y1 C  w0 f, |1 q
  • 选择新建全局代码片段文件。. D$ K/ A: K# b2 D4 C5 `$ |# o; ~
5.jpg
( k# r9 u+ v+ A5 |3 \9 V/ e" ?  M
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    8 t+ g) A0 q" v8 j* y4 T
6.jpg 1 x' L/ G% t' N- P
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。- E9 j& d% \7 P- i8 S3 ~
7.jpg
5 y( m) y. H8 K$ ~0 V       生成的代码片段如下:
7 S0 Y( l6 ]" J  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;
五、打包: x, F  h3 V- x  u; V  w
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。3 F4 ~5 Z( [& v/ r' p% G
六、发布
5 u/ q- N8 ^6 ^: C* V+ \- A       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
7 ?( {, i  G" Y6 w 8.jpg ( P" \8 p  w+ v$ F9 R
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~3 f7 A! [' _0 K
9.jpg   ^$ J' E- f# J( Q# C
七、结语: E2 a2 X7 G/ }; o& @
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-3-2 04:53

Powered by paopaomj X3.5 © 2016-2025 sitemap

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