QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5264|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言. R- S" H. f. G+ y* M/ K' `  n% C1 I
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。) T" ?3 K! T% Q3 m5 h0 v/ z0 |
二、环境准备
0 x" w4 C% M; X* }$ [4 r
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    , n( y4 i5 T% @4 W/ }' z# E, m
三、开发者账号申请
4 b+ b( i8 J) s( ~1 @3 A9 r9 y       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
; o; J: ?6 C! m4 W% C1.注册并登录 Azure DevOps6 s: c! C1 i4 n0 o5 p" ~/ w
2.选择或者创建一个组织(new organization)。
6 N: E  A& s1 ?3.在该组织下创建一个项目(new project)。
7 c5 I% g; h0 e       以上三步都是为了获取开发者(publisher)的token,获取token如下图:. ^! k6 c  h& O* c) C# k6 z
1.jpg 2 }' v' ~+ K/ ]) R: W' V
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
4 V. R1 m% `9 s( ?" P/ b- ~ 2.jpg 0 \5 l; e. ^! f. v' ?/ U" @' l
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
9 z2 g/ H9 m9 A- w1 p( e3 U三、项目搭建# i# w# B" x! Z1 M* n- p$ n; R
1、项目初始化5 I: T6 G4 M4 y. u4 C7 t/ v+ O
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。3 C; R9 Z: {7 ^" m# ~
3.jpg
, c5 v; k: P1 @4 A- n/ u2、项目改造
0 a0 |! w, D$ U       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:0 S2 ^! c) @" Y( _, X+ P* W
1.将package.json改造成以下模样:/ s. f4 t* m: {
{
  "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包会失败。
% Z) t. n  ~6 Z6 q' T3、编码
" z5 D9 k2 b  z3 f1 S       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
, g! j4 F: ]) U- X. v
{
  "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 A6 F, |1 H1 e5 m3 c四、调试
3 o# v, v! ]% ]( S  m  o       单纯的开发代码片段的话测试和调试都非常简单:2 y7 ~# C9 K) F! Z/ c
  • 首先先自定义全局的code snippet。- w( V, Y- {, z+ E: I7 X' K
4.jpg 2 a; l  K& S$ f* q  N# c7 y
  • 选择新建全局代码片段文件。
    ( |% R4 Y. K+ b. u
5.jpg 5 X& W. d) W0 ]6 {$ U$ `% B$ Y  O
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
      k4 y1 I, q0 V4 o  x
6.jpg
7 D8 X" ?! c* P/ C
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    2 t) z+ g) i: R# s* `' v& ]3 }+ O
7.jpg
# S1 L  G1 a" Q8 R1 z3 N$ Z1 R* o       生成的代码片段如下:' I6 i6 [4 w- I& O4 d' a5 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;
五、打包
/ Y8 w# |/ ~3 b% l2 ~9 Z       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
/ F; w3 G( P9 k+ p六、发布
5 S7 S! _3 [, L* b       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!* ^  Q, |" }8 ?% K* e- Y
8.jpg
9 K: B2 L( @: h9 o- Y* X4 M; x       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~4 K4 @1 W0 u4 y1 m, ]8 O+ n! c
9.jpg
( a, w3 X9 e9 R3 I) G8 {( X七、结语, ~8 Z6 B* Q9 b7 m2 i0 Z! v+ a
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-8-10 11:29

Powered by paopaomj X3.5 © 2016-2025 sitemap

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