QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4977|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
5 z' a* K( [8 I       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
! O. R! {; |7 `% v1 n$ c  S二、环境准备
. t( T7 r/ N: d: |3 E
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g* @# |$ ^' J: A3 ^  g3 Q
三、开发者账号申请
, n  A$ i; @8 H) c       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
  \& s, t+ t- d3 ?  t, K1.注册并登录 Azure DevOps, A9 U, K9 J( L- m4 i7 S
2.选择或者创建一个组织(new organization)。
( N8 d. R  G" M* G- O. r6 L6 \3.在该组织下创建一个项目(new project)。
4 n7 p3 x/ g  N2 ]8 r# B       以上三步都是为了获取开发者(publisher)的token,获取token如下图:0 r% C' J; p( Q1 |( I/ w$ K
1.jpg
$ b/ L, P, G; Q. d: Y/ X/ C7 D4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。9 v5 b. m) P/ o3 @( K! D8 A8 ?& j  a! M2 b
2.jpg % P8 X! q4 L" s
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。) L% ?+ I7 U+ \8 a# J9 R
三、项目搭建4 i9 ~) A- e  j5 ]" T/ e( Y
1、项目初始化
9 I5 m# D; f5 S
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    $ I; @4 i- D$ l3 n& q5 J6 Z
3.jpg
# W' `/ t2 x( n7 x, M5 n3 F: \2、项目改造3 V( t4 ]; S+ `2 K) H6 Z
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:$ x# N% h3 {' o1 n8 l
1.将package.json改造成以下模样:0 D& j6 K5 P5 w1 L$ l1 p
{
  "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包会失败。. O% k: z% f: n
3、编码
. i8 a8 C" e" W* S; R       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:- d5 L# x% m0 ?! Z) F0 n0 J
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。1 @  L& p2 H( m: z$ t, J
四、调试
; I7 K. @3 X& c5 o8 c% v* _       单纯的开发代码片段的话测试和调试都非常简单:9 d; j& B' p+ k: i1 C
  • 首先先自定义全局的code snippet。
    / J2 p1 t+ w; `1 V3 A  y
4.jpg
3 Y, V7 L/ T: Z) R- h
  • 选择新建全局代码片段文件。
    4 `( t) r1 z2 l
5.jpg , c3 {% b6 V: J' M
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。# W1 X8 H0 A" v
6.jpg
+ I* N! t% X& F4 s" `
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。, b$ n1 F6 v& A* j& _
7.jpg ' W6 g- `; h2 {' {
       生成的代码片段如下:1 ~( w, u0 s1 o' L/ K  o
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;
五、打包
: J) g4 x3 C% g* W2 K* K       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
4 n2 x* O' Q+ W) |: F1 {六、发布
6 ~9 x5 h6 r% D       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!- @) m' ?4 {& P/ w
8.jpg % S4 R& c( ^& w9 l
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~' _% f( ~1 c8 ?1 [% V) N
9.jpg 6 T* q  Q$ e0 ^" Q" l
七、结语4 v. }  j+ i1 Q, @. V. a
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-4 08:14

Powered by paopaomj X3.5 © 2016-2025 sitemap

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