QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4533|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言, J! Y. g3 T1 ?$ p( _9 `
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
# U' S7 D, p& E8 {2 d9 L二、环境准备: B( I3 K! B9 W- b( h4 k
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    ' L5 i2 Q3 U0 j& Z, V0 ~1 d
三、开发者账号申请
8 B7 {' n, X4 a; V1 h2 l2 r# z       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。8 m+ X0 H: ]5 {. y& h( F) G
1.注册并登录 Azure DevOps
- H# R& r; A8 s+ R0 {9 u$ \7 A2.选择或者创建一个组织(new organization)。0 A2 h; w* l7 w" o. J3 U
3.在该组织下创建一个项目(new project)。' Z$ w, Z; N+ E4 q& A
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
6 \  v( P/ _9 y 1.jpg
& J* r* }5 i4 `# c& c7 D4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。1 }! K. l: d2 N( X/ j7 M
2.jpg
* F1 ?5 T: F7 E/ T5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
* I7 ?, G+ ?* i2 H' {  U三、项目搭建
: a( G$ p* h* F/ u1、项目初始化
: _) ~. \6 |( N1 s& Y
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    $ a0 c5 @  e& o# X3 M1 n9 Z
3.jpg # t0 \+ t7 I* S! w/ e7 |7 ~, o: x$ ?- _/ \
2、项目改造
! S4 h: a, Y4 w/ q/ [$ i       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:, L) R1 K8 B1 r* \8 O
1.将package.json改造成以下模样:7 x+ z( L/ E0 }8 R
{
  "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包会失败。
" Y8 J2 U9 `1 P/ s2 N3、编码
% g5 e2 P. s' H       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
; `7 {; E. }+ ^$ Y
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
/ h& g# m/ W& y- s, Y  d四、调试
0 \% }! b8 G3 y) ^0 m$ x       单纯的开发代码片段的话测试和调试都非常简单:
8 Z1 B6 c6 O  V
  • 首先先自定义全局的code snippet。: z  K8 [. H0 l% U6 \$ n, L
4.jpg
6 P! K  X* w4 t5 D: H( K- b
  • 选择新建全局代码片段文件。3 o) W6 E) D/ q3 D# E2 k
5.jpg : O& q! O% N: s) w4 \: N
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。2 a$ m( r1 g0 \  y
6.jpg 2 q  [: y4 y# M* e- J. B! p
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。5 u2 v# I' E! v9 L' A) w# z
7.jpg
3 k, _' T4 `# {       生成的代码片段如下:
  ?; L- b% y  C3 ]. d8 N0 n' N- ?) K3 x
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;
五、打包
# {+ `( u% H1 G- x/ f# F       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
/ k& v% ]1 a; Y- z6 l% V2 h7 V六、发布
8 V# Z$ V$ j- K# h       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!: K3 d, {6 e2 B( t7 w8 ~
8.jpg + C* y0 w/ N4 v" b% c
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
, e/ r0 m+ o. B, V* w 9.jpg , w1 A5 b7 h6 P2 |
七、结语) n& A  g, n" U& \0 m0 U% t  d7 f
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-2 17:14

Powered by paopaomj X3.5 © 2016-2025 sitemap

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