QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4692|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
; L+ p  n, ?+ s/ R       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
0 ~4 L8 I& t* v5 R二、环境准备! u) F- k+ c6 G) ]! k: j8 `
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
      _+ `/ e  k5 c, w4 {0 G/ `* G1 f
三、开发者账号申请5 P& _; l" i5 ?* B
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
+ O: H7 {& |4 Y1 Q3 Z! s+ U2 t1.注册并登录 Azure DevOps
3 U- X9 t" m7 s* H/ J$ l2.选择或者创建一个组织(new organization)。5 v7 G" o4 r% `( G" ?* d6 D% o/ ?
3.在该组织下创建一个项目(new project)。! T: L* G7 P! p, R' J
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
" z" @# ?! N. _% A! [! i0 P/ \$ ~* H" U 1.jpg
( `" `2 A2 r0 d2 ?! D8 F4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
$ A5 T' N$ @6 e5 _- o* D 2.jpg
6 b: T8 g7 _3 @  n! S: j7 s* m: j5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。- y. X0 {5 k! O
三、项目搭建
1 T$ L8 k* {2 n1 Q: w' ^3 S1、项目初始化  P1 s. \' ^' t* l
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。( P& j" V. a2 C* U
3.jpg - R% d5 W: z  B5 B: z0 C$ \
2、项目改造" F1 K& T. p$ K7 y. x, m
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:3 E: k5 A- V" m( n/ y. {) Q
1.将package.json改造成以下模样:
+ k& S% W; N0 H8 @& W: Z/ E, V
{
  "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 M1 a6 w4 b7 {9 l7 n$ j$ D3 B* F9 b3、编码
# D& T$ t, W! R  f  W& C3 a4 M, P       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
% t/ V0 C$ u1 l4 w
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
. O3 e$ v" s& v! p! q: ~四、调试; V) S- ^/ |- K$ O' r1 d# y
       单纯的开发代码片段的话测试和调试都非常简单:0 ^+ }" @! z6 h" z" I; l
  • 首先先自定义全局的code snippet。
    3 f: x& Y! B6 J
4.jpg 6 X6 r) @$ S* b! K
  • 选择新建全局代码片段文件。
    7 e9 N3 M9 B9 y  C: v+ u
5.jpg
% w* j8 N) n9 V7 P$ Z' Z+ [* B
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。% d" C5 h3 ]4 Y/ n& W. I: j
6.jpg : Z2 M( j2 l) G8 h
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
      t! V0 D, b' G. |
7.jpg & H- l* q6 y/ U# T# S
       生成的代码片段如下:
/ {6 [, E$ \6 `( q5 m
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;
五、打包
, ~" P% {0 l9 ~$ m       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
2 c; S8 @0 j/ A  m: C六、发布, X( A1 }- Z: Q. p8 u7 J) Y5 ^, \
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!& l  T0 w' i2 n7 Y9 }# q
8.jpg
1 L9 s* f# G, F+ V- _% P       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~& a  k7 T) [% Z0 y/ p
9.jpg 8 u$ o% r' m% K! k* u' N
七、结语/ ^7 {7 M5 B- {4 G
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-5 14:48

Powered by paopaomj X3.5 © 2016-2025 sitemap

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