QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4204|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言' ~6 s1 D. Y2 e! K4 F5 P
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
0 M6 r8 p* ~7 ~5 G# b3 X二、环境准备
" W- _1 R8 m( P. t" x2 b8 f
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g& ^& i, J: ^2 }) ~$ s  E' `
三、开发者账号申请
. A, \! {( |# [! u9 n" I( O/ L& L       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。2 G% d7 k& t  z7 I4 X- P: {
1.注册并登录 Azure DevOps1 |$ V8 N) Z' f9 H! `
2.选择或者创建一个组织(new organization)。
/ M" d- I$ i# H+ }/ X- J5 P3.在该组织下创建一个项目(new project)。
/ f. w" f' R9 C       以上三步都是为了获取开发者(publisher)的token,获取token如下图:& u% H. @9 L4 g& n* C
1.jpg % g, U; g* s7 }( P% P  ]
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
: C$ k6 D  h( R. r" {5 ]; w 2.jpg % Y/ f8 [% V0 a8 ?6 n3 d4 ]' I
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
/ y8 w2 \5 G/ F三、项目搭建
) w6 F/ E* L2 R+ d1 s2 h0 g1、项目初始化* C* J+ t$ h5 Z& @' q/ w4 H; p& f
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ; W  z- I; y, L5 X% k
3.jpg
9 |- u; `8 H; r" E9 u- M2、项目改造$ s8 N' c/ `4 d8 `- o& V
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:. S9 Y' v1 ^; ?" U6 o$ n+ x: P; B/ F
1.将package.json改造成以下模样:2 m9 B$ m, u& {* j0 I( ?
{
  "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包会失败。
( u2 I+ e! N0 Y3 L! |0 \' U3、编码
2 x$ _6 b5 g0 X# B: V       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:: \9 Z& _9 Y- {+ V5 ]
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
7 v' |+ U4 V2 J5 s; x* B3 G四、调试
& G+ `, f$ A9 }# U! a# D       单纯的开发代码片段的话测试和调试都非常简单:
$ B" b6 ]: d1 _7 n" Q7 X
  • 首先先自定义全局的code snippet。
    0 \! y' g: x# c& d
4.jpg & g, M3 ~4 p5 p3 x: l) X  ^
  • 选择新建全局代码片段文件。
    2 n4 ^" ]% @* S0 p
5.jpg 6 S' }% c, ]; z9 F* ?
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。( W  s3 M# W5 R' @& ~
6.jpg
+ F) F1 }0 a7 h# o
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    6 a) f+ J& g1 Q: e% I9 g- T
7.jpg   f6 n* G: ^. R1 D: K$ S0 s
       生成的代码片段如下:; b9 j. T4 {2 u, O4 L7 F( {0 X& }2 x
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;
五、打包
# w# Z. H' V+ p$ c       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
) N% f6 a+ s; \" k六、发布
4 ?* f' |/ h, D- Q' v( [       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!" r) z8 P" c( e9 p* g6 r( u& W; F
8.jpg 5 ~  }' J3 V( b7 L. }/ W
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~6 M6 _  _* q  n! _
9.jpg
5 C  T- r- [2 P七、结语
9 f8 R  E8 f0 S& {       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-18 14:22

Powered by paopaomj X3.5 © 2016-2025 sitemap

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