QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4786|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言5 D4 c1 p8 [: h' j( v8 ?
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。) P2 [) @6 E8 @- z. f0 a. E
二、环境准备. t" b  ^! W. C. t+ w
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g3 C4 [8 m9 n5 v% ^" `0 v
三、开发者账号申请
8 [8 g$ l% w9 R' F% }5 Q3 s0 C% F  }( k# B       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
$ y+ |) X' ]( X% S4 H1.注册并登录 Azure DevOps+ w) l5 @* n3 V+ `6 [6 B
2.选择或者创建一个组织(new organization)。( M" U) V9 p9 N, @
3.在该组织下创建一个项目(new project)。0 Q) a' T/ d9 i4 y! r' I
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
9 v0 i- ^3 r1 L 1.jpg 6 ?6 y7 a/ ]. d; W. {
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。8 R) t& g4 t$ t* T4 u2 I: n
2.jpg
8 ^) d# x9 F& u' G  ~' g5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
/ W: D) T2 u# E9 N& B2 o4 F三、项目搭建/ s6 |3 R) o8 s$ H7 N9 |) T
1、项目初始化9 K, O5 N- |3 c4 l
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。: S6 Q# f& K1 ?. S, h2 O
3.jpg
3 w: O3 g* [0 ], v2、项目改造
' R+ C: B. }: Z+ ^3 T" s       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:, S0 m, x  O( Y* b8 }; ^) D& Q
1.将package.json改造成以下模样:
7 h- F+ p  b! F2 z  @& L( g
{
  "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包会失败。
: @' n% e9 T1 ]3、编码
0 L1 z5 a! |0 [4 s5 v" T       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
( U4 P6 U5 j7 h+ q
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。/ q) t# B9 D7 G3 j+ n" L
四、调试
& t8 g+ M7 q# i! |# G       单纯的开发代码片段的话测试和调试都非常简单:# E; b' a9 R8 I0 Q
  • 首先先自定义全局的code snippet。
    2 ?' @- J7 L' N$ {& \# a2 N; g
4.jpg + ^8 d, S+ H! x
  • 选择新建全局代码片段文件。/ @" G/ X1 t1 ]$ g. p: L+ d- L- g) t
5.jpg
0 G$ b% K: |' h  l# u
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    % T9 ^) S8 A5 `) T! x, R6 x& h
6.jpg
/ ~4 G. c* C4 M2 p: D+ S5 o3 R
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    8 D- p& ^& w9 }+ @0 t
7.jpg - W% V: V+ {  {/ |& ]) B6 t
       生成的代码片段如下:8 t" g% ]( p' j  A' t; U' F
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;
五、打包5 y& [% u6 _) q+ P5 v6 V$ d
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。! _% f! Z$ ]. G, l7 B8 Q* i
六、发布
& _8 r; W6 |/ p4 ~; y3 O       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
9 _0 a9 [3 G% w5 o2 d; ~9 f/ w 8.jpg
/ l" A$ H+ ~0 l8 ]5 g       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
+ b& q+ t: \6 C! E 9.jpg
  \  k1 ^7 t' `: o& U七、结语8 o! m6 h( L/ m# V3 r3 v: F
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-15 08:25

Powered by paopaomj X3.5 © 2016-2025 sitemap

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