QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4804|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言+ M1 v5 L/ X/ \/ ?. G$ u
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。  O% r: ^1 v6 K3 H+ H5 u1 p7 ~
二、环境准备
& o' E* ~3 V: U+ H' }  k
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g$ i' p* `( M( b* V) ^
三、开发者账号申请
9 f' G3 v* \0 G% f. _% w       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。2 L; l$ |# M: E' W! i: j% j
1.注册并登录 Azure DevOps
: W7 g. h( k  W4 c7 }2.选择或者创建一个组织(new organization)。
+ d" R2 n. p; [3 x, N3.在该组织下创建一个项目(new project)。1 F' o; T6 C) s. @$ d( S
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
# [$ [) C3 Q- ^/ D4 A" t 1.jpg
- Y! f- l/ S! n' g* t4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。, a: u9 L- w* C' h. B* m7 D$ G! |
2.jpg 0 ^3 n2 y* L: p
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
$ ]/ l! [- I4 ~5 x; p9 E/ {5 ]三、项目搭建
* e' p% L' b7 T' `0 }8 o1、项目初始化/ O$ F. k4 |0 p; N  q
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ' e: u& q' ~- e& g( D/ o
3.jpg   {0 V9 I( X+ a1 m5 K% v( q4 u
2、项目改造
* z$ A3 N$ `: M' {" b& R; @       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:9 ^) A# ^6 }6 t3 n9 n" h
1.将package.json改造成以下模样:* K& E2 {& E8 ?) C/ ~# e, f
{
  "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包会失败。
( j7 Z. o9 v* ?) y  [+ u3、编码7 l5 L* k: s- P
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
% M  f& Z" {+ ~' w2 k
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。: z. [( K; Z2 Y% X: D3 s3 k3 i+ n
四、调试
5 Y( N. ?8 V* [' F       单纯的开发代码片段的话测试和调试都非常简单:6 J; B0 d3 @4 g5 ?
  • 首先先自定义全局的code snippet。
    6 _5 a' y8 {7 P' A  L, A
4.jpg
( }5 s  r( r3 e8 m
  • 选择新建全局代码片段文件。/ M2 I4 G5 H, v. P; n
5.jpg : U6 K8 R0 k$ A3 ~3 m( m! c8 T8 p
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。' ]6 p  r+ S  G# P& Y
6.jpg % q* j. |9 t1 ]7 M
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。/ C- ?3 {- R; w) ~
7.jpg
9 ]: i! P4 U) O4 \5 [5 @6 W1 N       生成的代码片段如下:" ]% D$ m* b4 G/ {+ B1 W
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;
五、打包( z  f$ R" l8 r+ |3 Q
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
% }5 i8 W& @4 N7 P6 Q$ F1 f) |六、发布8 s7 f( j6 B4 a" y+ }
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!. w$ l( Q" u% ?
8.jpg
# ?) `4 ]' p5 |- X1 T% l       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
2 J2 M4 D, L2 W" m/ W4 Q 9.jpg $ K& M  ^% E: L* O1 l: m
七、结语
! t: A) h/ A, v       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-17 10:13

Powered by paopaomj X3.5 © 2016-2025 sitemap

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