QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5273|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言+ @& K6 [% L- U. L5 F! r
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
( u3 Y3 V% \1 _二、环境准备% D& p0 V6 ~6 T% B% ^6 v- ?
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g* O3 D3 D" `4 x% C1 m
三、开发者账号申请  v& J+ e' L1 t7 l( p6 g9 \! j
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。0 \' z& b4 f' m2 ]- h1 E, C' b
1.注册并登录 Azure DevOps
. l, s  C& ^8 `' X9 H2.选择或者创建一个组织(new organization)。5 o' S& K6 a7 Y, N) p+ x
3.在该组织下创建一个项目(new project)。' m2 m5 t' }) y* n) M; Q2 |
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:7 ]0 b# x% \: \- |4 U& x
1.jpg
* U- [) ~& Z2 ^) i: ]. D' x4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
) ]; s9 U# H& P/ B; B 2.jpg
: x; X1 y' L& r7 t+ L0 k5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
9 g* \8 X. l" x+ o) u5 o三、项目搭建
* s! M- g+ @  b% e: Q7 g+ x7 @' P1、项目初始化
/ I- p/ P5 j6 O7 v
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    6 ~$ b$ E* ~: }
3.jpg
9 Q! ]- u1 z/ H7 r( V3 Y' o2、项目改造
, q% e- _, q2 }: u3 l# k       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
# F3 W5 @' g# W* u' B1.将package.json改造成以下模样:
9 Z, F0 W! S, Q1 \/ z
{
  "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包会失败。' L6 [! r3 x" g* U
3、编码! Q4 A; I# p2 w5 g& ]1 f2 H; D  X* G
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
: O- U$ y! ?! [: _8 A
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
4 L$ c$ S# r8 |  t四、调试
- h& t" z6 z7 e       单纯的开发代码片段的话测试和调试都非常简单:6 ~5 n7 y/ j6 n( L
  • 首先先自定义全局的code snippet。
    , ~) d! l; k' i* @  `5 D: U
4.jpg
6 c5 b# a4 Y& w( e# ?5 i% K
  • 选择新建全局代码片段文件。' h/ A3 S! W* Z! ~
5.jpg
- S! R5 y; m- N" Q8 f
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。' ?# @7 \* ~( A/ `/ @( j5 j
6.jpg
3 a: m: K: R( K4 ~  J# X" o
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    * L' ]! G- D' n3 H
7.jpg * N* F6 E+ x1 g- p" G
       生成的代码片段如下:* J6 |! Z, _1 V$ e( v; G8 ]6 h
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;
五、打包; \+ _! W' i7 u* K# G
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
; ?* e- X; `0 V- [9 V六、发布1 J& f* I$ P! S
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!1 w, ^9 O1 o- K& S+ }7 ~+ \0 d  x
8.jpg 1 h8 f) W0 Q3 G; @* ]
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
7 g! g$ {: A: L7 F 9.jpg 6 ?1 }9 F! U, S5 b% k( |
七、结语3 p* {; F* r' K+ ?' d
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-8-11 01:28

Powered by paopaomj X3.5 © 2016-2025 sitemap

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