QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4373|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
! d3 @: E" \% T       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。- z& C# Q: p" P- G
二、环境准备; v) n" E5 X9 x
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    7 l4 @1 L7 L3 l! }# t& w, Z5 m
三、开发者账号申请
3 B& e( X' ]5 j# e9 K2 K$ a, @       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。3 }3 {5 t" X9 t+ m3 {, F
1.注册并登录 Azure DevOps
' {/ |. H$ |# H- i3 f/ k2.选择或者创建一个组织(new organization)。
# d( {' W% ]- M0 r* R3.在该组织下创建一个项目(new project)。5 H2 O. o" u& R- x
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
5 E* ~9 ]) g; V  q 1.jpg
* B$ a# {/ h  r& y4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
' \4 E3 x# A; x$ n$ I 2.jpg ( E- Y0 }3 M3 ~- p4 _$ c; s: O
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。0 q/ X6 W% [" O% S1 G1 ~( c3 N/ y
三、项目搭建
" M- v  E+ D5 |0 t/ p2 K" T1、项目初始化
& a( p+ P) i' l& i, D( t$ p
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    3 w9 j' t$ {9 O" C, _' O4 p; o
3.jpg " n# o2 m1 S/ I5 X
2、项目改造; ^3 T' O( H# y6 W. p6 x
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:. r- b( e7 L/ n3 V2 z
1.将package.json改造成以下模样:
( L4 {  L; I9 C* q1 g
{
  "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包会失败。2 \/ D* O% j( v7 k  g$ X$ Q/ m
3、编码3 K2 h: z& {. z) r
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
. s8 v1 k8 ?1 u/ `& R. b0 z* x
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。! |( h+ J6 H1 z0 m
四、调试- o: [4 \' P  j- X5 m7 Z* R
       单纯的开发代码片段的话测试和调试都非常简单:
: W  b/ f$ F* F6 i0 i
  • 首先先自定义全局的code snippet。
    . {" \5 m: S+ w* a$ R
4.jpg
% n' v; B  m5 ?' R  o, j, a% t3 r: Z
  • 选择新建全局代码片段文件。& ~1 k7 C, E- I  L6 a
5.jpg
1 N) @: p& O  w, ?) T8 x( v
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。  q$ l2 H) Y& m7 m& n% K8 \
6.jpg , H. H* M6 A" q' y
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
      c$ {0 I; O6 q+ G  r. |# e1 \
7.jpg
& r: Z3 e; y) J; a       生成的代码片段如下:% g- a% O# D) i" b! i
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. J- q- x5 A' R4 S6 P( H+ u       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
' S) Q0 f1 t8 h! l六、发布6 k9 E1 c+ @( E3 t4 Q/ l
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!( p6 A" F# m1 V' e" p
8.jpg
% @+ p, N5 s7 ?. }% u0 B/ }  D       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
$ }/ N9 d% b" T+ H" ]1 M* n& d 9.jpg
* v- U; T  X* J. Z8 n, P9 ?七、结语0 J4 S# e% s: l5 d
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-3-8 18:20

Powered by paopaomj X3.5 © 2016-2025 sitemap

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