QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4597|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言+ d3 ?* Y  q2 l" }; s7 F
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
. q: Z' H( y% I* Z二、环境准备8 t: H. H, ~  t. a, ^
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g) Z3 R& x: N7 y. ~5 j" H
三、开发者账号申请
6 R- w1 M5 l5 p1 y+ [& \       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。, d) G& x% W9 v( _% B( x/ H! m( D
1.注册并登录 Azure DevOps
0 X3 G2 {/ p. v5 ^& P2.选择或者创建一个组织(new organization)。
: O' m5 P+ W  z. J2 x3.在该组织下创建一个项目(new project)。
0 t2 v5 Y5 x' o' y; _. L+ p/ h       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
) n: ?/ M4 n2 y 1.jpg
0 B, q& }( h: e/ ]9 D% m- t, m) i4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。1 G& ^5 ]) L7 h( L' x
2.jpg , u. b9 S2 z; I
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
/ @9 e) m* k) t9 J) V三、项目搭建
& A, {1 v7 D6 a) B- t& A1 J# p1、项目初始化
: s& W- s, m( F+ }& H! E* `
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    2 B% D, P' P+ a- P4 S# ~2 z
3.jpg : p: n5 H6 v- B, j+ t4 c
2、项目改造6 g* y, i/ r5 C0 G$ L! e
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
# j& ~6 Q  R. f' J2 J( R. S8 ^1 f1.将package.json改造成以下模样:- R  Q0 m% P3 C/ u
{
  "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 O3 x4 |) q3 |' ~$ h% g3、编码/ K8 r5 o% S3 m: y" o5 g# N
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:+ v; M: y. D: Z: B9 |
{
  "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 z% F1 m# a' S5 x% l7 U/ K
四、调试# z3 C. G3 z9 Y2 V6 Z9 a) m6 D
       单纯的开发代码片段的话测试和调试都非常简单:# \7 S1 H( [+ L; C
  • 首先先自定义全局的code snippet。
    0 i  I' d* B% T
4.jpg
3 o4 Q- Y4 h) v3 ^' N! U
  • 选择新建全局代码片段文件。% f' o* s6 U" v9 G) `  A8 z8 d7 F
5.jpg
5 F0 j! O1 H9 f$ @( F) ^0 Z
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。3 S$ v2 F, _* Z# S/ _. }) s
6.jpg
: d& r! B& i6 ~  b' x
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。8 @4 ?8 ]$ U1 N8 c4 r  R2 `
7.jpg
! ^5 V8 q; e9 u4 B' d6 Q. a       生成的代码片段如下:6 B- ?3 k: ]  Z% k, B  @2 I% U; Y" ?  `
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;
五、打包
5 u. g* a+ X# Z3 C  b6 C# N3 K6 G       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: q* I8 y$ B5 N4 x6 i2 @
六、发布
/ u& X* f1 n: M% k' l, b       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!; t( c! l7 O1 j8 x
8.jpg ! D& T3 Y0 \9 V% t1 e
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~; {; ?" e4 A) @( Q: k# s8 \; \8 N
9.jpg % e0 O9 i8 J* w0 g  {
七、结语7 f, O" `0 Y9 C( K
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-16 13:02

Powered by paopaomj X3.5 © 2016-2025 sitemap

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