QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4592|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
9 ^& x6 W3 P' Q; S2 \0 X       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。' t; @7 [! @8 L1 ]
二、环境准备& y  w6 G9 A  \
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g9 x' b* w) `# d( _
三、开发者账号申请
7 M  K( O7 n! [2 l) C( p$ w       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
: c5 h! X6 r( F: z$ Z  C3 J: k8 ^" u1.注册并登录 Azure DevOps/ }7 ~8 ^6 U; [% E. @9 v  J
2.选择或者创建一个组织(new organization)。
# Q# Z, {+ p2 K* `2 h3.在该组织下创建一个项目(new project)。8 P/ q4 K. x1 X) A$ Y& z- e
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
" s3 D  X& c& i( d% T; K; a 1.jpg
( v0 `2 `, s1 R% c9 C, s$ Z4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。3 b  w6 ~' A) L
2.jpg # p1 g1 s  G5 T; t6 S( h2 u) |
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
3 {1 S+ U/ F' {& U2 w5 D$ R三、项目搭建
7 b1 n; c( l; K& g9 q5 Z9 x1、项目初始化( G& J" C8 f4 `  J
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。( v6 t6 I$ i& A; H
3.jpg
8 U5 C' I- x% i& x4 c$ b2、项目改造
0 M2 b6 A  Q8 e4 x: V! Z       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
, h) F+ n# y9 c, B+ T' b1.将package.json改造成以下模样:8 k5 u3 L3 T. N% u7 N0 _! b
{
  "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包会失败。
& D& V! B; x; }& g' u: F3、编码
5 l* s! V- Y& D/ H/ z8 i8 l       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:/ O; }5 C; w7 |8 q4 g# r
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。8 c1 @: r, z9 A
四、调试
, }* T8 \, {1 [6 l  ^- @1 C       单纯的开发代码片段的话测试和调试都非常简单:/ p$ h% ~' t4 b$ y. J
  • 首先先自定义全局的code snippet。! d5 z' q3 |: c: p9 M; {
4.jpg
0 R  @, }! S- }6 D9 Z6 O
  • 选择新建全局代码片段文件。1 y+ F5 Q2 c% k* B* K) W
5.jpg
. [  o3 {/ V! D% |: _) @8 c4 ^- X
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    ; M) L  u0 ~. f) a* L
6.jpg ' T- [6 b4 X' [! ~+ b# Q4 ?
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    7 d7 N$ e7 ~7 n: O* T
7.jpg
* o; ]  v/ Q0 l, T" F, W       生成的代码片段如下:' V; r( \- j" B; p6 k* }
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;
五、打包
& f! }' }( V/ T6 O+ \       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
9 l7 l7 X! C' G# s7 J& ?) n1 Q  P六、发布+ ]% Z$ d+ s3 f+ F( L5 E$ d' S
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!( O2 S8 j& l$ n# g) V
8.jpg 7 \9 I  X* D7 _( h9 X) y9 P
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~- L( A. o3 v( {; z7 \4 m
9.jpg
" ~  U7 G- |4 d七、结语
; N) o" `  j: d$ L3 u; i0 c$ ?7 p$ S% [       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-13 14:44

Powered by paopaomj X3.5 © 2016-2025 sitemap

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