QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5165|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言) v9 R9 ^6 t- O; V$ P9 |
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。8 x" x7 E, P; |3 w# B8 ]
二、环境准备
2 q( p; ^- x: P3 Y% W
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g2 V9 o. z( T+ y3 d
三、开发者账号申请
% s3 U2 r# v- h; `       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
# h' z8 J' O4 t1.注册并登录 Azure DevOps
+ f4 S, t! G8 ~* V+ T- J# e1 K" C2.选择或者创建一个组织(new organization)。, D( }8 L: {4 @1 j1 d) w. ]+ X
3.在该组织下创建一个项目(new project)。
( _$ @7 e  z8 h6 r# K- N. S3 ?       以上三步都是为了获取开发者(publisher)的token,获取token如下图:6 {" \9 Q( c/ T$ W# u8 J+ t
1.jpg
/ Y: b$ Z5 R9 Q( Z8 P4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
6 w+ N0 L( K1 R, @( d 2.jpg 1 a8 M2 c" V. M6 z2 @) u
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。* o6 a' _/ H5 p# X/ K
三、项目搭建
1 y  v& ?- b  d% B1、项目初始化
+ G5 `' r/ P+ d* z# u$ Q: A
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ; J/ w3 R+ F% {- ]9 h
3.jpg
% B7 ?3 k! ?- a* C& L1 |0 w7 f2、项目改造& n/ L& \7 x+ h) p, `# V- s
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
0 r2 T$ I& j8 t( R! H1.将package.json改造成以下模样:; x- _2 @$ ^! E: Y1 h: I
{
  "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包会失败。& @# |) _; k8 m  ]" i/ K- S
3、编码
/ p3 ^  w% p. J2 V# s       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
# U, F) ?' P6 v8 q
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。3 A9 o9 R/ e. \  K9 q) e0 K8 r1 b2 ~
四、调试
/ b+ T4 o+ a7 b2 ^       单纯的开发代码片段的话测试和调试都非常简单:
5 P. e* L+ O0 G' U$ d
  • 首先先自定义全局的code snippet。4 X# x3 _0 `3 y: E2 H9 w. n
4.jpg   G  P8 E. l; Z2 l( v+ M3 a
  • 选择新建全局代码片段文件。6 b4 c: a2 s) e; m2 v0 P6 R
5.jpg ' n! E5 \* H* P7 Q; B6 I
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。7 z3 W9 m9 O5 ?' R+ x7 }( P
6.jpg
( J: r# Y6 i- m$ i1 p" A
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。/ z% j, s5 u6 e9 ~5 U- A
7.jpg
& T1 Q* c  l; L' |+ G       生成的代码片段如下:" Q# I% Z2 F+ ~$ R* C; |& k
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# m9 P) l" s7 ?       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
" d% v. R& c& Y$ t9 }六、发布+ Z; C/ Y7 A  ^/ a0 [
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!& D4 m9 L! j1 L! l, b9 P
8.jpg ) |5 R% e! B. L) f) ~
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
4 G3 n2 Y6 h% K* e) F' l) I 9.jpg
1 l) `( V+ u3 V3 I2 D. ?七、结语
( F% s" i' _0 G$ J# L3 @' e- @       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-26 20:01

Powered by paopaomj X3.5 © 2016-2025 sitemap

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