QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5094|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
: s0 b) Y5 B& t1 Z* v+ \       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。3 {7 I# {7 r8 a. y
二、环境准备9 F$ m- V# w+ x# f& x
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    # I8 D# {  y. M0 |/ n
三、开发者账号申请7 c8 h& R7 Z! g) r) A1 a, y
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
# [4 h, n7 u4 @* j1.注册并登录 Azure DevOps
1 _+ j3 b/ n3 r2.选择或者创建一个组织(new organization)。+ _* c7 A9 F! A5 f& k
3.在该组织下创建一个项目(new project)。
5 M3 J+ O2 r1 j3 p( i       以上三步都是为了获取开发者(publisher)的token,获取token如下图:! V" ^/ J: g8 Z) {  W# D) ]
1.jpg
; e9 ^; A2 V9 R4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。7 T* x6 `% S( X2 x2 {2 n" c  A" p
2.jpg % G6 u6 X6 ?# Z* ~) ^' C1 }( u
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
) x3 B( c8 b/ e# H三、项目搭建
6 S2 L6 c0 k$ K1、项目初始化4 v9 |  d& K" S0 j$ s4 p% d
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    & E, s, Y+ h2 H" ?7 Y
3.jpg
: ]  p; N3 H3 k+ l2 b2、项目改造7 s1 t: k8 s, U/ o, Y* P# U- r
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
% k! T& [9 t  J/ t/ L3 B% f1.将package.json改造成以下模样:/ V' c- T' Q2 w8 b* Z
{
  "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包会失败。: c/ J4 K, d9 R( Z5 J
3、编码
0 }1 Y; ]  z" D$ Y: F) l       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:4 z$ o! f, I6 u/ O3 @! y) G4 \, l7 \0 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
6 ?, k3 Y+ S4 g1 L$ K3 m四、调试
7 d1 e% t. r: t/ u4 M       单纯的开发代码片段的话测试和调试都非常简单:& {& ^; g! z$ j; Y6 t/ j
  • 首先先自定义全局的code snippet。
    $ H9 ^( h, i! E! f; u) k/ I" T6 \
4.jpg   B0 k5 }- F( S: R
  • 选择新建全局代码片段文件。
    % _+ a/ d( X4 h1 g- _. F$ t9 x
5.jpg
4 }" e9 z- c7 ^+ _. D6 g
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    ) _9 y' ]8 I$ V
6.jpg
- Y: X: r; |, [; z% i
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    $ H3 u* V# h0 s4 M, Z4 v' H( B: p% ^
7.jpg $ Q* Q8 p7 T- m0 M+ S( {
       生成的代码片段如下:
& I- `: ], x' j; 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;
五、打包8 f5 s- t' l% ]9 S% `+ w
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。4 s, J! v3 D  e
六、发布
% B+ B% s) l5 c3 y       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
9 A, z! W9 n) y8 T/ s1 [ 8.jpg 3 u! t( p3 j/ O
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~/ V2 z% o5 g& R" o7 C: |6 u  H; k
9.jpg 6 g6 b& x& b6 d: o& H7 W
七、结语, c& I; \; `! {; q- |# C( z) V
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-16 21:28

Powered by paopaomj X3.5 © 2016-2025 sitemap

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