QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4544|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言' e/ M" }+ g6 ^
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。6 B4 \) x& ^" Y, V
二、环境准备
* A. Z( X; a  E) P+ R
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g2 X; L  K# N" ?) |- O* u- V
三、开发者账号申请& {  w! |0 ]4 I2 s. z: f* e
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。, ~5 F" m$ p8 B/ _* `0 B; }
1.注册并登录 Azure DevOps6 @- r& Q- u! h) P$ D5 @
2.选择或者创建一个组织(new organization)。
- O- q* B4 ^* a8 s1 t3 U* X3.在该组织下创建一个项目(new project)。
  R1 A& Q3 s1 _. x       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
  ^9 Q+ i4 c, o8 a5 d; J4 W5 C1 F 1.jpg
0 I8 V: n  j& T& e$ k8 F% S$ o0 n: @; u4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。6 z( C3 M- Y! `0 B$ M* ]
2.jpg
  r' I/ o6 E; {# R! q: C7 w5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。9 I" f* `  h# @! c2 s3 e" w
三、项目搭建4 w* Q: e0 _7 F/ @: m
1、项目初始化3 a0 h3 k! h. {" f5 i) F
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。( Q+ s- R; R" _* X; X9 t- b3 w
3.jpg
# n5 P; J& b: g3 }) T& g2、项目改造5 f. _4 _* G$ k, B$ C
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:$ Y. Z% M) T' L- e( T. u5 v
1.将package.json改造成以下模样:( e6 e# N& d' P7 L5 l5 R: w* l
{
  "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包会失败。$ Q8 ]: V2 G+ }0 N+ }
3、编码
' H9 c- b7 v) }" q7 y1 @' `/ E# z       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
: H* }6 E, d/ V; W
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
. ?* F7 k" ~' n" V四、调试
8 ]& ~1 ^  \1 ]$ v+ ?# z% S       单纯的开发代码片段的话测试和调试都非常简单:7 p& r9 T" H0 t5 ?
  • 首先先自定义全局的code snippet。! Q/ D* Y, b9 Y# ]3 q; X+ h
4.jpg $ I1 W9 B2 y0 H4 G# `1 N  P) `0 T
  • 选择新建全局代码片段文件。) B3 |7 |. K4 v+ U1 g- q
5.jpg
$ ?  J& I8 S' d
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    7 }, n$ x  [) q
6.jpg
! f4 D8 f! Y1 b3 |# F+ v/ x8 p
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。6 E, s. B; {! j
7.jpg ( b4 }; K: @8 x2 H0 {% R
       生成的代码片段如下:
$ ]7 N$ H- p2 C$ ^7 [& D! E1 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;
五、打包
8 g7 x$ j7 r+ V9 w, U3 p       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
& ?9 Q8 A) }$ b) l  L六、发布
# J5 P# W" D2 O* p4 k5 L6 L/ q       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!( t! C4 s. R8 O* h/ M& ]" K
8.jpg
. j( b9 U9 i/ y       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
$ u0 R! o: L$ D9 H8 H 9.jpg $ p0 f  ^% R! f  V: ^
七、结语" W% n, j' O& D% @
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-5 15:36

Powered by paopaomj X3.5 © 2016-2025 sitemap

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