QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4530|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
5 x5 Y$ L+ @3 \) g       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。! j( l6 Z9 f  w( b! f
二、环境准备+ h: L8 g4 Y" B6 ]  z3 [6 ~2 f
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    ' W; ?) Y- u* b, @# P
三、开发者账号申请
2 v* }, r5 Z  l       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
- A" f. B- `7 J# n; f: A1.注册并登录 Azure DevOps
. Z" q+ H: V- U2.选择或者创建一个组织(new organization)。8 z& B& _5 h( T7 Y7 R8 N' D9 C  P# t
3.在该组织下创建一个项目(new project)。+ [- u1 ?; G/ T( K
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:6 D# S$ j% F. q8 f
1.jpg
2 _! Y* v8 t8 R' ~( o$ k$ ~4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
9 q& U- N- _5 s 2.jpg , C8 G$ w0 N" \% Q& g  t
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
# ~5 }$ `: ]0 p8 y# L2 n三、项目搭建
+ n8 m) z$ b( b9 D$ ^+ U. l1、项目初始化$ d5 l9 }: P2 p, A0 T3 O+ b* e
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    / p5 K+ Y/ s6 `+ ?% L5 ~- G$ f
3.jpg
! f! v/ R* @, F6 j1 t2、项目改造  Y0 U8 M; i4 w0 {% K
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:* `; J' I  I; r" R
1.将package.json改造成以下模样:) S& b) v* q: M
{
  "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包会失败。6 u9 g; J9 t$ F
3、编码) f5 [) ~- s& H6 m
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:( F& ]1 G/ n; L" I2 B1 z
{
  "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- |) K0 j7 R. |) I' z' S
四、调试* o% z- T. I5 r  ]( N6 ~' h
       单纯的开发代码片段的话测试和调试都非常简单:
7 H! ?" _9 H6 H6 F
  • 首先先自定义全局的code snippet。
    3 B% S8 W* M9 `6 ~) j, Q# S
4.jpg
/ U" Q9 R5 h" E/ m& b
  • 选择新建全局代码片段文件。0 \0 u7 K9 @# X  o# C
5.jpg 3 U5 S3 w- q2 v4 ~  `( K
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
      c5 X! [( {) @4 `9 S0 w1 e( [
6.jpg
# J( ?. X* _' A' }% d
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。/ M9 r! |" p( L! e. i0 d4 K2 z
7.jpg . T+ j  B, h5 C/ Y
       生成的代码片段如下:: Y; O7 J9 G8 m* @/ s1 \& ^
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;
五、打包! z8 x* I5 r- t5 n% p/ E
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。6 P) Q  }% u1 I0 e# ]
六、发布
& b# N$ [+ N4 b4 j( t. d       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
  O3 A' V  s6 x' m$ o 8.jpg
* U6 M. l' o+ a  ~7 M# Y% i; U       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~' O! ^% X$ V. G# d7 x9 q
9.jpg
2 V7 F1 N2 l* w' }+ p七、结语' A- a4 a- m/ l' G; D
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-1 23:28

Powered by paopaomj X3.5 © 2016-2025 sitemap

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