QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4361|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言0 X2 N6 b) k# T  n8 J* a
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。/ }+ v2 f, @2 a' ?
二、环境准备6 ~8 s' @9 z$ i* z4 r
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    / X$ _5 a# ?. r# K
三、开发者账号申请. ]: y/ _* q1 M8 V
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。8 l" S7 k$ `# }( Q% Y/ w
1.注册并登录 Azure DevOps4 T; r& L# L3 p. r/ Z7 n
2.选择或者创建一个组织(new organization)。4 h+ G7 g0 D7 @; h7 s
3.在该组织下创建一个项目(new project)。
( [8 A; D& R7 V8 P9 {0 x+ a       以上三步都是为了获取开发者(publisher)的token,获取token如下图:' O; z3 z3 E* ?+ C5 h2 b/ c6 a
1.jpg
9 E9 W" ]0 x9 n7 }4 U0 w: Z- I4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。5 z& Q. Q! w9 x% d
2.jpg # Z% [7 w2 P  J; `3 @
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
( Z/ t% `; [/ G0 l" s; D/ R; ~5 r三、项目搭建
; N: d( T, F' _1、项目初始化
7 p: Z6 n+ D( d- S0 [
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。# f& v. ]& Z2 n! Y: E" |$ E
3.jpg " X2 e  Q3 [. r! v- a
2、项目改造
0 Y* w( |+ ?4 d; P' j: b* h, e0 }       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
2 a) A2 i( ?& s8 M0 ]7 J1.将package.json改造成以下模样:
, S6 _9 f6 [7 y
{
  "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包会失败。
% |9 @% z( S2 m. B- ~+ l3、编码
/ w6 ~- p7 [+ Y* \6 D       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:* d& C1 d+ y! ~6 ?% Q) B5 f
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。! s, N7 I  Q+ T: T: j( f/ Y7 t
四、调试- b0 o0 K8 \2 L" D% {
       单纯的开发代码片段的话测试和调试都非常简单:" u2 q8 Y* t8 K: |) ~( K! F
  • 首先先自定义全局的code snippet。/ f( D* v7 c* p
4.jpg
# s& z: \! t9 e0 g" f
  • 选择新建全局代码片段文件。
    3 q, b5 r. I) M! K1 w6 Y( p* q
5.jpg
6 a" ?+ o4 c- H; m; ]  f
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    + u. A( q: U3 a& ~" I* E
6.jpg
  R4 B" r, }- L2 s
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    ! C; b( H' t* \: I
7.jpg 9 E1 B% {9 X, P" L
       生成的代码片段如下:
7 y$ l2 J" j6 Y) Q
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;
五、打包
3 t* {  q& ~2 y4 y6 U# Q2 V1 _( e       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
+ o$ X) j% Z) `% O' e- k# s  g六、发布! n6 Z3 y; P; v4 [. H+ O6 B2 n
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!* z; t- e+ j% L' S/ u
8.jpg
8 x! W! U3 x$ W! L0 {# N       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
/ k; b7 v) F0 b) D# I. i) n 9.jpg ; A2 z' G, }7 G
七、结语. L7 V( w. @# }
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-3-4 03:15

Powered by paopaomj X3.5 © 2016-2025 sitemap

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