QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4759|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
" B# v- P3 }0 @: D( R# i       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
. i2 d) N0 p4 g+ ]9 t二、环境准备  m" a, ^1 B" c) W
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    9 q, z3 c( m$ Q* b
三、开发者账号申请) H) C% U& n7 Y0 e$ @7 D
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。# e6 d# |; J! I2 _+ a% {
1.注册并登录 Azure DevOps
3 `+ o  z& r4 B5 w2 L6 @2.选择或者创建一个组织(new organization)。
+ Y  a1 A+ ^9 K& b$ h; I, M. B" t3.在该组织下创建一个项目(new project)。: }1 S* i; {9 G: l' x& A! ^2 _1 j
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
( S8 G! H0 [# z) L4 ]/ V, F. j 1.jpg , B9 N3 P. T- {
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。( `0 a6 c" ~! \
2.jpg
' H  y8 A/ ^3 b5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
) D6 T9 `! s: @8 _' b: ~# M三、项目搭建: M' d, L& h# \3 }. a1 W7 p
1、项目初始化& g4 ~# H( u6 O$ N! T- y* J# I
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。) T4 c* |6 V# m$ o$ f
3.jpg
' @' S, A7 I  R6 Z' U( ~2、项目改造5 r$ x# u1 {6 w% g7 V9 A
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
! N# g0 D! n5 @9 h' X: q8 m0 C1.将package.json改造成以下模样:! t3 N$ c& j8 {+ s; P6 @9 t# D
{
  "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包会失败。
# b! S/ ~4 _2 Y2 m. Q; ]3、编码. C; s* v3 n  [% h, }* F' D
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:: {& H$ V6 e# H' d5 T' G$ 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
6 `. d( j/ |! \四、调试
; [' J% K# `! Z3 ~2 V" K9 o8 l       单纯的开发代码片段的话测试和调试都非常简单:
$ i1 G* E; W. i! C+ }. [
  • 首先先自定义全局的code snippet。5 G+ J9 Z7 I) }" j6 @3 t3 |# {
4.jpg
- F/ D) |% q6 ~
  • 选择新建全局代码片段文件。8 y1 p6 W2 C: B. g/ M
5.jpg : g% \5 f6 `1 W  q
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。* ~, W2 I  ~2 n. v& K
6.jpg
6 Q+ v1 k+ U5 Q- d/ @
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    * P; V( n5 D- D  }6 |5 Q2 y3 V
7.jpg
, i- Q3 L6 \' h" X8 }' k+ U       生成的代码片段如下:
( V- O" G' A1 y6 `1 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;
五、打包
% ~: D; \% T5 w1 _$ _$ @! _( l       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
  q( y3 M2 y6 c0 i六、发布
# b" ?3 k! {/ ?6 ?5 I       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!9 P( b, f+ ~2 U; M+ n; ]* [  K
8.jpg ) a0 X- B+ L) E( [; O/ J
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
) c, N0 U: X! d6 S- K, c 9.jpg 3 Y. M0 J) w3 |( L$ c) P& x
七、结语2 B+ a9 W2 n! G
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-12 15:17

Powered by paopaomj X3.5 © 2016-2025 sitemap

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