QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5058|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言/ }' g0 F& X( E( B/ Y
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
" d4 ]& u- c3 |; [7 d7 a) Y% e, V5 b二、环境准备) f4 @3 ^! q6 j& b6 w4 `# t
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
      v, Q- U1 F4 b/ |
三、开发者账号申请
, |2 Q) v2 y0 Q' e$ X3 C1 d& |       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
4 }# c  I( @( Q" L9 [4 o. D1.注册并登录 Azure DevOps
, N7 ~- m/ ]/ P  t+ W2.选择或者创建一个组织(new organization)。& i5 K' o+ v( R  _6 b5 L
3.在该组织下创建一个项目(new project)。
1 ^3 V; }( u: B# ~1 J       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
/ e9 e; c8 K  j0 X) n7 |3 y 1.jpg
( `6 H* J0 q4 o- f& a1 j/ N4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。3 \- v' g7 X% h$ i
2.jpg
- H0 H/ z; y% B) ?5 X$ Y9 T5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
* R9 C, i. ^& y* E三、项目搭建
: f3 B+ h. {2 j" b- w1、项目初始化
$ M+ ^" v8 T8 q2 Z& m9 ^; }
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    - c# c, }' H7 Y- q
3.jpg
0 F4 t8 x, d* Y2、项目改造
5 _) u7 Z+ q' V       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:% w0 E7 s  ~. n. d! N2 V
1.将package.json改造成以下模样:
, V: ]. K8 _$ n& J8 e! E9 S6 f
{
  "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包会失败。! v1 @; p3 b" g0 x
3、编码
4 Z( z4 V7 C# _: T* D; l       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:) Y# g5 f" l5 ~5 X2 T$ Q" O
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。4 `4 r& M/ i- X: z9 a$ o' b
四、调试+ n6 K# O% V, K! ~0 L4 J9 M
       单纯的开发代码片段的话测试和调试都非常简单:
5 f6 r, @5 ?2 n  H" U9 d
  • 首先先自定义全局的code snippet。( |% f/ g. b6 a, ]# L
4.jpg
3 s5 h' N0 g$ s! [( m
  • 选择新建全局代码片段文件。6 v5 X' {4 x( Z4 S' O6 Z
5.jpg ) [7 T$ Z5 ~: j- n8 l
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    - c+ e; O- n1 O3 k( M* X& ]
6.jpg 4 N8 Z4 S- f" r
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    ! E: m; u- a5 w/ {
7.jpg 6 H* q" b1 T- F' i
       生成的代码片段如下:
9 u6 r' I  c9 e9 u8 M9 [
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;
五、打包
. a/ l$ k/ a1 `- a+ b, |. ^4 Z       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
7 Y( `9 e7 I& P* }! }$ O六、发布6 m+ t. h1 S/ M* z! @4 n. E
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!% x  u  N& c+ ?; @2 q
8.jpg
" ?6 E& x4 f; M& _! G, q       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
, x+ |7 J6 B. |8 k% s 9.jpg
, e- P% B3 {% Y" T七、结语' K" h( ]1 E1 `5 H
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-12 01:46

Powered by paopaomj X3.5 © 2016-2025 sitemap

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