QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5230|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
5 V3 k' T" L' {# A       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。0 y, ~( c! B* |. q3 d" F9 p
二、环境准备
( f- o/ X( v  Z# N. A+ f+ b
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    % ^; j9 e1 [5 U
三、开发者账号申请) I4 Y- o7 d6 G+ Z0 O! Y
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
" U3 x+ u6 f9 Z. ^3 a1.注册并登录 Azure DevOps! r# E0 d" u( b: ~. o3 T, |
2.选择或者创建一个组织(new organization)。' D! `2 S1 u: |- i8 G$ g
3.在该组织下创建一个项目(new project)。
3 B) Z  x! O+ g3 ~0 C7 K5 |8 [       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
% `, {! J, ~% G% Q& H! G 1.jpg
) g" o1 `+ G/ B, @, N4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。0 N* Z! A% z2 @  L& h
2.jpg
/ B% s! T1 |+ E& p1 A8 d9 y; ~$ W5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。0 M( x# A# l6 H& B
三、项目搭建
* @! u, p% E# h7 T+ \1、项目初始化8 X3 i- m" \- d: c% d9 z. X
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。" _3 u9 \% k0 B
3.jpg
" z7 K* j4 J8 F$ D2、项目改造
* j$ X* P- r5 X( B. c       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:9 R7 f& [8 r3 m" [' `' h/ G
1.将package.json改造成以下模样:4 g6 Z- v0 S6 Y5 D) V9 w( `
{
  "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 a3 H. Y. {) O, P. y/ q
3、编码
* E% J! U5 u( F7 y) }$ ]       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
8 I4 g1 V' M& L0 y
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
& s3 j2 {2 }6 r/ L9 Y3 {, m+ H四、调试# t: l* B; J* P3 j- U0 Q
       单纯的开发代码片段的话测试和调试都非常简单:
  ]- @  W/ I* g$ r8 W2 H) x
  • 首先先自定义全局的code snippet。& ^8 c0 J8 b5 |0 R
4.jpg 4 E9 y& J- [- a* J8 k6 g7 E* V
  • 选择新建全局代码片段文件。3 L5 ?" P" O+ n) @
5.jpg ) o/ @. Q" m# v8 p0 U& ?
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。# T% T6 A5 U' _! E0 ]
6.jpg
# N2 H5 \  V8 y; p1 u) S7 o
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
      T  N" J1 h9 m9 X% v
7.jpg * ^" `/ D  D+ U, N. e
       生成的代码片段如下:
. C' t! n7 y, L/ I  Z$ r+ @# z" w
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 N' B* G7 W: E6 R% ]6 z8 U: a       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。6 q0 V8 u+ s9 V. h  W
六、发布
) s) w! o( Y9 e1 S       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!2 q/ K1 N, h0 P1 q
8.jpg
& h( a- a+ o; o! f% J1 V       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
- z# L# r: I' q, ?$ M! j0 ` 9.jpg 5 C) |6 @1 V1 ^* w
七、结语% k) z# h" p+ n- S. g( I
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-8-4 23:55

Powered by paopaomj X3.5 © 2016-2025 sitemap

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