QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4516|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
# o: N: V0 Y8 x/ Y       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。% k$ O& C. {7 e; D) \
二、环境准备
! \  s+ x$ r1 ]$ A2 W
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    3 Y0 p' Y$ s3 h' I2 O% J  f* m
三、开发者账号申请
+ T) \, G5 _, U' s& o       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
' f. U2 P# S% C  B5 l3 u1.注册并登录 Azure DevOps
) `) q! [/ y# h9 J2.选择或者创建一个组织(new organization)。) @/ L% a7 ^9 K0 l, p- M* N% Q( e9 @
3.在该组织下创建一个项目(new project)。& k+ B) F1 ^# ?* d4 l# {7 ?0 a
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:5 M2 [( ?, [1 f7 \* j
1.jpg ' J% r. [7 o& W% m7 v6 k+ ~
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。6 i9 `* g4 g3 P* s  P6 a" P$ t9 n! G
2.jpg
& D, X- s% t. Y( H5 {# ^5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
3 _( e% J# Q/ H6 D# y4 K& Z6 a三、项目搭建, E  p  `. b0 V) B
1、项目初始化( C  u+ N+ `8 Y3 L$ w
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    . `1 M2 M% o) q0 G& Z) G
3.jpg
* a) Y7 X) \) f  e' \5 N2 g2、项目改造( ]1 i! a% l9 t, {: F# O
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:, m' O6 \0 R. j5 e/ V' [" a% S
1.将package.json改造成以下模样:3 N. F. J4 l- t5 ?( t
{
  "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包会失败。
# x, U/ N$ l4 X( y3 I! R; Q3、编码
' a7 K% E4 C6 B5 z- q$ q* D2 E) Y* F! g; [       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:& t) g0 v7 _* ^9 p2 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。% O' b& n5 D' l- J% U
四、调试
3 ]7 O0 S* w/ T+ l$ r! `8 X6 U       单纯的开发代码片段的话测试和调试都非常简单:
0 w5 T( V0 i3 ]6 C
  • 首先先自定义全局的code snippet。& ]" o' x' m: V7 {! M% ~' J
4.jpg 9 r3 u- y: {' r" y3 _7 y6 H( b. x
  • 选择新建全局代码片段文件。3 T' g* s5 F. Y$ n# ]
5.jpg
. D; W* z" i5 z# g$ _* x# Z
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。+ N6 H; u* G; `2 `
6.jpg " Y( ~4 R' s, f* O2 f/ I* {/ s
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。. \. v7 a$ j" H) j& m- b0 i" I5 V
7.jpg ) i( t: y& K  O1 V
       生成的代码片段如下:# K" ]( Z2 M9 E' S4 `- p# c
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;
五、打包* s/ K1 l9 K1 E9 |1 J0 r( f7 o
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
4 a' V6 I/ y8 `) I+ e2 t六、发布
- F  J1 u, d# n, J       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
! U3 s- K4 a( l% c$ s( ~4 y 8.jpg
' n- \: A5 p( z! [! n8 k       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
3 _9 U/ y- S) [. @ 9.jpg ) C% F% f9 b4 d, b! u. _2 ]
七、结语; H8 w4 Y4 \) D
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-4-28 11:21

Powered by paopaomj X3.5 © 2016-2025 sitemap

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