QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4462|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
8 j" }  e. t# ?; h9 k( `       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
6 e+ I% E/ o; s+ j二、环境准备; X2 l; c# n/ p! s1 z# M  A
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    : b+ m% D. }: m" Q* K# c# t
三、开发者账号申请- c  _! ?! H% q
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。: v% \/ S7 \% i) C/ Y% \
1.注册并登录 Azure DevOps
, n: I; j( p; t1 h6 ]7 g9 `2.选择或者创建一个组织(new organization)。
( g2 l( H7 r, H3.在该组织下创建一个项目(new project)。" i4 T1 j, H' b3 B
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:" |9 P; ], q+ I
1.jpg
0 G  g$ L3 S2 R2 \( \) V7 b4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
. x; t5 z  o7 K 2.jpg 3 J  e7 i. i* j+ K/ F! g
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。# X( O! h% V+ \& a5 m
三、项目搭建2 c7 }0 x) a9 G
1、项目初始化$ ]- p7 Q7 o" w' P" ?1 |$ B7 f
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    1 A; A7 v4 k, L  e
3.jpg * r* G% o$ S6 b5 T' [3 z: \
2、项目改造
$ u- C# p6 h& b: `% d: \       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:  w4 U; L. n- u7 e2 l) d+ I
1.将package.json改造成以下模样:: h# Z6 J/ i& b  _) I
{
  "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包会失败。
) a3 |1 E  C, h3 M5 S* S3、编码
1 o$ N( k$ }, m7 u       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:+ i4 G' C% `8 n0 j$ m
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
* D# W+ s- f  g9 n+ M四、调试
; z: I; ]- l/ v# A" m8 A       单纯的开发代码片段的话测试和调试都非常简单:7 [9 Z2 g  [  b, x
  • 首先先自定义全局的code snippet。5 |+ G! l( a0 ?6 b1 g8 a6 A
4.jpg
  ]/ m2 z0 p2 F# v5 S4 h
  • 选择新建全局代码片段文件。# A  h: W  d: N' D
5.jpg
; V3 {7 ]4 Y9 ?7 h6 e
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。9 b3 }* j" P# C$ l  S$ @
6.jpg
1 N# k) I; x- K1 A) `
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。* c- X" s0 Y8 H, ?& b
7.jpg ; W: r$ P8 w1 _! V* m" i
       生成的代码片段如下:
3 o5 k; Z% ~# O" U% f) D3 o* T
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;
五、打包- F9 _7 T2 E( M2 t# B! t9 u) w
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。! z. F. q& T+ g7 d8 c1 ]
六、发布
6 A+ |" K5 B0 z0 s       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
6 o, s% k! {/ T* V7 e5 f3 S 8.jpg
) G4 q. \1 y8 y       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~/ j" E! u; N6 Y5 I$ O
9.jpg - Y# G! U  f2 z9 q2 Q/ M3 M" A
七、结语
  m9 o( z: v1 F1 `! E& B4 R" V" f       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-4-13 17:03

Powered by paopaomj X3.5 © 2016-2025 sitemap

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