QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4778|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
  H2 d% V1 S2 V: M* C% P       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。3 d& p: u3 R0 l3 C+ Q7 ^" \8 p' V
二、环境准备" s% S1 ]2 y4 o- C+ I
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g$ C4 W4 s% F  R9 y4 [" B
三、开发者账号申请
7 j5 Q+ B" j1 a( \       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
. [7 }7 }' F$ g1 n& V9 g1.注册并登录 Azure DevOps3 z6 R8 c/ l5 A7 A( e7 f" h, K
2.选择或者创建一个组织(new organization)。
/ m' P( ^/ q5 s3.在该组织下创建一个项目(new project)。% Y1 p5 F- r6 D% f
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
, e% M; h( q5 I+ X7 e 1.jpg 5 o$ ]8 @( Y1 N% c6 A; E7 _, c
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。7 _3 @6 N0 P8 s
2.jpg 8 m; [* ?/ j, a/ n  E
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
1 d+ w5 f: C0 Z9 O三、项目搭建+ j4 P1 i! X: c9 @+ m
1、项目初始化( Z/ }* S8 O; o
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ) Y: `2 d1 h: D9 J5 a5 S" m
3.jpg ! y- n+ B, N- ~7 `4 f
2、项目改造. G0 h% \8 `+ g
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
) Z7 d& }. d  Q6 q; C' f1.将package.json改造成以下模样:+ i& }2 z: ?. z' S- q8 Y& B/ 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包会失败。
. @6 x2 b9 ?, R7 S& s( ~# _1 S3、编码& ^; x  l2 R8 Y/ z. B
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
# ~/ Q/ A" S' }; f! I6 _! H
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。* |9 _6 Z! N* R" E9 c
四、调试; T: s( v: I" V* i/ a* m
       单纯的开发代码片段的话测试和调试都非常简单:
# _+ h. C4 B( `$ p8 X5 {( i8 s
  • 首先先自定义全局的code snippet。
    , L4 K. _# K& l7 o9 S' q
4.jpg , g# L6 Z0 k& B7 p% D. C1 E/ |
  • 选择新建全局代码片段文件。
    ; m, \& {# O* n+ Z& i
5.jpg . u) ^3 u: I; O1 d7 T/ t- {
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。+ L2 F6 W$ l5 Q% x$ z; p) i
6.jpg
3 i8 A. W6 \4 Y' r* |9 y3 \
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    , k2 F$ N4 ]* k! _0 v2 Q
7.jpg & D5 Z( x& X3 l  ^7 O& B. d
       生成的代码片段如下:
( y- b& S8 d. l
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;
五、打包
0 ]% o/ ^" n: f( Q       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
1 r6 S* l' x+ @; V+ t1 F$ ~六、发布: }! F) Z1 j: @( ^" F
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
# V) s* t7 y( X% N 8.jpg 5 j8 l: n& @- V7 _1 T4 N3 H8 T
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
/ m. s" x$ K  Q+ e 9.jpg * n3 Z# W& `4 _! u
七、结语
3 x3 S7 o* ^5 R# q' G  W: C) m2 u) m       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-14 05:20

Powered by paopaomj X3.5 © 2016-2025 sitemap

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