QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5104|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
7 \( R6 V& r# v       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
/ o( @& w5 _  I% U二、环境准备0 H6 z; G+ m: |/ L7 [) ^! u
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g* n1 n# s% ~) A* G* Z
三、开发者账号申请
3 k5 k, {6 ]  w/ Y4 I  X       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。- E' r7 [# R3 G% n5 f( J8 A
1.注册并登录 Azure DevOps
# ]# K0 E% M5 P* ~3 v6 }2 X2.选择或者创建一个组织(new organization)。
0 w! n: F* o+ R) y7 b0 a" F, f3.在该组织下创建一个项目(new project)。5 ~9 Y1 [" r* ^1 j
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
, V/ X5 g- M: j" d. \ 1.jpg ' M5 ^5 p& d% ~: c. B& `
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
* M7 Y/ N7 f- A2 ]" n 2.jpg 7 \% r2 f* w  i' H# k3 l. b
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
/ i; V4 o4 B2 a三、项目搭建
: T3 c" J' x" V1、项目初始化; }5 ?4 ^) ?5 J
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。4 c+ _  O# ]# {
3.jpg
$ \5 C' [' ?5 i9 f  x2、项目改造$ p9 N& S  q; f6 _  X
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:- _: T, W* Y" x4 H7 e$ `/ |
1.将package.json改造成以下模样:
' s  \  I- I& I/ }' D
{
  "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包会失败。
  Y3 v8 N% e% T# i& `0 C( _3、编码
) a' y) r5 k% P       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:4 D: e# n; x4 j. W$ B  ?! \8 n& 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。3 r+ E2 w* }; T$ {4 H9 o; S% r% t
四、调试
9 ?' R+ w5 U0 m/ A       单纯的开发代码片段的话测试和调试都非常简单:
) I6 n% T1 G  n! G* p7 ~
  • 首先先自定义全局的code snippet。' ]7 w% ]4 s% [8 o1 D: |6 F1 @/ b
4.jpg 9 J/ B0 h+ W2 z! Z
  • 选择新建全局代码片段文件。$ c5 h: g% N/ M( c: c# H( d4 y; i
5.jpg
& L3 Y3 R( ~' M7 i- n. d
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。- v8 j% P: B: {% W& x
6.jpg
" A5 n5 Q  r" ?" O% X4 y5 Z. Q: v
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    - W, S* L1 E; L
7.jpg 6 U1 @' L4 `  I
       生成的代码片段如下:
5 m, Y! F2 i0 p5 ?$ T
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;
五、打包
/ p/ z1 H4 X, M9 C8 s0 |       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
8 d% |, w8 O9 K6 J/ m六、发布
1 s6 R3 L& W, [7 s! M) f! x$ p. E6 ?       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!6 ?5 L$ h9 A1 l
8.jpg ! g( W. ~/ L1 I! K1 K. f* }
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~9 l2 s9 Z# k+ v7 z3 z
9.jpg
  C6 V0 T6 N- `" J3 T七、结语1 k0 S( O# s3 j5 s% K
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-18 08:25

Powered by paopaomj X3.5 © 2016-2025 sitemap

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