QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5029|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言5 c2 o/ k- Q. c6 K
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
3 P( e, F: ], W3 h7 Z6 f二、环境准备. O8 N5 v$ I+ m4 O0 i
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g! w4 M& e. a* J; `: x7 C" F* q: A% X
三、开发者账号申请
1 U4 ?5 J' C) d9 t, W       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
8 S" M( M5 e& D' R1.注册并登录 Azure DevOps4 V: {4 T9 Q  r( F) k
2.选择或者创建一个组织(new organization)。5 ~( f% w) p1 k
3.在该组织下创建一个项目(new project)。- r' P! r" Q2 g* p4 u
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:9 y/ f, C$ m3 }$ V
1.jpg
: Z2 c% P( f5 \4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。5 I' B5 ^1 O- Q4 X6 g
2.jpg
- N( k) _* a/ [; c5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
3 l5 z3 \4 J# v# m% v5 R$ w. z2 R三、项目搭建0 L( A- G5 g9 E# \
1、项目初始化) u' o/ m* T6 M" l( B
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    - Z( E% n1 _9 t' D
3.jpg ; Y! g- ]+ ]! q& Z1 F/ T% {3 H
2、项目改造
& G5 e3 C6 J+ F7 L5 R- v       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:. u- {+ v" M) }  R' x0 _
1.将package.json改造成以下模样:
- Y/ o/ x; s! ]( _' X, Y: n" W
{
  "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包会失败。7 Z8 i1 f4 f/ G- P! \; a* x
3、编码# P( ?! r4 x* l# `
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
9 k. V, z; L6 h2 H4 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。9 }2 g1 \( N! V5 ]" |4 j
四、调试
$ a) J. Y$ u- ]: Y  G       单纯的开发代码片段的话测试和调试都非常简单:! x) w% ?( W2 y
  • 首先先自定义全局的code snippet。4 B8 }  z' f1 z( h
4.jpg   i3 ^0 ~0 m' M8 w6 t* |
  • 选择新建全局代码片段文件。
    ' }3 b2 a# |- U( z. J6 o  J
5.jpg & Z; d: J: D5 D3 f
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。/ ^- O, U7 [. y+ U. v8 F( P- `' o
6.jpg * t! f; d* l% A+ o. A
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。. I) f- X" p1 N7 R$ T
7.jpg
; g& C  X& ^- K       生成的代码片段如下:
  X2 r) L) m8 L4 v  U" G0 D" u
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;
五、打包4 G& J" r+ f7 A; j
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
* ^  A, E: y4 T3 Z' R) Q2 T六、发布
7 j$ g/ b/ ~! g8 f- `# w       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
& m7 S; N* o# s$ B$ T 8.jpg ( {, j9 P# F6 c7 k, P* L/ u, A6 j( U
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~" O1 h" v( J& `! L% ?, b( I
9.jpg
6 u# L3 m; H( h2 Y5 Z7 a七、结语/ q: d# j0 w) ~- x, Y; ^
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-9 02:34

Powered by paopaomj X3.5 © 2016-2025 sitemap

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