QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4947|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
/ x3 [% |5 T2 X% P* f+ y1 u       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
; K8 T  M+ x& ~% Q/ x' o二、环境准备
- \+ ?( Y. P" i8 D/ z
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    / a( n0 p( {& L) H  d
三、开发者账号申请
+ X  G& S# ^9 ?! g8 i       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
+ M$ v2 r/ w! W$ c# p1.注册并登录 Azure DevOps
* s7 ~& v" |4 G0 f/ i" j2.选择或者创建一个组织(new organization)。
2 a* f9 d$ ?/ S" m3 @3.在该组织下创建一个项目(new project)。7 G  y0 |$ x8 l
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:+ q' Y( r. V/ r) X1 h% w+ |  _
1.jpg
; u% l+ z5 i7 _2 u5 F' Z4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。. b1 ]2 K  @& t3 Q
2.jpg   Y3 R# `0 z( K$ W# m/ X5 ~2 u7 A
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
" N9 S) l, @  A4 m3 D三、项目搭建
% C4 U# u8 V+ m* n1、项目初始化
# z9 L9 c5 g( ?
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。+ O' j2 O  ^" k8 n9 j: N: C- {3 ]8 j
3.jpg 6 P! a( f1 b6 r$ C: d. c
2、项目改造
: U- q9 F" C' n; L9 g       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:& ?8 d8 k3 Q6 R# ?1 m
1.将package.json改造成以下模样:: S' N  J8 G. H6 x, j( 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包会失败。
1 m. ?. S9 ]0 _/ [) I. V+ `- u3、编码# h6 S) H5 L; O
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
; ~/ Q2 S, U: a( I3 H5 M- E/ `( a
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。2 g* i! z! D! d' Y2 H
四、调试
9 {1 H9 B" Y1 `3 ^       单纯的开发代码片段的话测试和调试都非常简单:
+ o# }$ i! T, {" a. d
  • 首先先自定义全局的code snippet。
    " K( T4 a, P9 ?
4.jpg - T' Q! F) f& M) l: J; U% S
  • 选择新建全局代码片段文件。
    / k. W+ X. ~1 B
5.jpg
% N/ S6 [+ R: X: {. r/ u
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    + v, o7 f& M% z2 Q# e& ^: g
6.jpg
* q: F5 F5 a$ Q5 c
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。% a/ H7 ~& Q( U9 H) u% B
7.jpg 4 R/ I' G8 t. v- x& k4 b: q
       生成的代码片段如下:
  j& \' J: V  B* W8 ]" h
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;
五、打包4 n2 @- Y/ ^) d& t
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。7 Y; ^7 o& N0 Z7 E- \% }, S3 P
六、发布7 _& o3 K: h# X
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
, W* N  x. r) y9 L2 H/ C2 m' B 8.jpg
- m% C# ^! Q6 K* z5 {3 Q       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
0 n* |# ?5 B/ Q- O$ x. r7 h 9.jpg
$ S8 x( L3 v: G0 s3 J4 i七、结语- [: Z. a$ k! S* N  n. r! X
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-1 22:40

Powered by paopaomj X3.5 © 2016-2025 sitemap

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