QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4606|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言0 Q0 n/ l* q/ y" D( W- x% v
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。  k! R  {/ {& u
二、环境准备7 q! q/ F  Z/ J( h! k/ y: G
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g, S* b) W) b) L8 D1 F& |2 d
三、开发者账号申请' C3 d2 Q" ?$ o3 T* q# h
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。. Y) e1 v0 J( D' P0 N* `
1.注册并登录 Azure DevOps/ {, h7 m8 Z- B, a; ^* x7 e
2.选择或者创建一个组织(new organization)。$ J0 d6 X$ T, _; l- _
3.在该组织下创建一个项目(new project)。
$ r8 k5 L* b5 N( L# X( j% F       以上三步都是为了获取开发者(publisher)的token,获取token如下图:% e/ m! u( w$ O& v- U  T  T! F8 ?
1.jpg " \3 O- m! i: A( I. k3 Y
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。% o4 J; L/ U2 s
2.jpg
4 E7 P6 U( N) @0 P5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
9 ~9 @$ G# L/ l( a' L* e三、项目搭建/ ?& H& f$ Q1 @2 r3 o: R* {# Q
1、项目初始化# k$ {4 [) c. I/ D: r- n
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ! c  M# U+ q" q* H3 Y2 z
3.jpg ) N7 l. w4 o: \$ J' H  c
2、项目改造
. Q3 z. R; }$ h! P8 V7 P) D6 [6 L       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
/ h  g6 [3 D7 U/ i% u4 O1.将package.json改造成以下模样:
% R7 l8 P6 O0 F  @% \+ K7 t7 `, 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包会失败。
  J5 z2 D2 A- Z; V9 u3、编码# n6 u- K( {* ^7 e  S- I, }  f
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
8 Q; d+ o* e7 m/ u3 e
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
, I; Q; }( m) w5 M四、调试( B. V6 ?' i0 q  S
       单纯的开发代码片段的话测试和调试都非常简单:
; A5 `; Q1 h/ c/ Y' w
  • 首先先自定义全局的code snippet。
    ! M0 s, ]) I, _
4.jpg ) D# r: z& Z9 ~& z/ g
  • 选择新建全局代码片段文件。0 t: E9 m  {* S; ~0 n: _5 a
5.jpg 9 `+ A! A. c- }9 y" `
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    2 T, N3 e' N: x
6.jpg 1 c3 e/ r& {  u6 N% m
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    ( N" G5 W( r& z' C8 {/ M9 n
7.jpg
# K- u* k2 W, _2 S) T# b% G       生成的代码片段如下:
# h( H: a! w# N$ g- 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;
五、打包: C8 f+ [5 a9 `& z9 k% ~* s) T: r% V
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
6 s! Y, W% `7 \, ^; X5 \六、发布5 _' J9 w2 D. u, b; N  f% Y
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
* h' h( v* z& a6 j8 i( T8 ? 8.jpg " ^+ [# Y/ x. R1 z. k
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~3 f  K1 G% D3 Y. G2 |
9.jpg # E7 ^# F& ]" [
七、结语# |: p. V2 X5 r7 v' k! o; l6 x
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-19 04:39

Powered by paopaomj X3.5 © 2016-2025 sitemap

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