QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5238|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言( r( k* L! k& N. Q- e- T
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
) G( d0 @$ u- P5 W4 u二、环境准备* t+ c8 R% w4 L
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g3 r8 M# o* Q2 \" O  Z% i
三、开发者账号申请
! F% k/ G  a, d  e, ]( ]4 j+ K  @       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
/ l2 l% a8 g! }- P, P4 {1.注册并登录 Azure DevOps
2 t8 x. I: U# y/ T2.选择或者创建一个组织(new organization)。2 X  F5 S7 K, e$ W$ W
3.在该组织下创建一个项目(new project)。
- E. o: F' Q7 _$ O) L       以上三步都是为了获取开发者(publisher)的token,获取token如下图:% F3 `0 p' o6 x, m
1.jpg
' o" z. W1 i) X9 P. @/ K9 e' J8 Z4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。4 A$ j/ O3 D; {& q' m, `
2.jpg
5 q9 T1 b  ]' @8 y7 d$ P9 G$ |5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。/ ]/ @3 ~7 i; Q  O) \' P3 M6 j0 s' H
三、项目搭建
$ v% k* X# |! G$ C/ I- A2 s+ N1、项目初始化  U- F! K' Q/ t
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。7 w/ B- [7 \# F4 a9 ~6 q6 m! y+ E
3.jpg / w  O+ t# ^2 ]. w& ~( m
2、项目改造0 K* g& E4 A  n. _" j+ t+ Z% W+ A
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:1 _) X+ [% o( r& h, k0 u
1.将package.json改造成以下模样:9 q2 ?0 m' w$ d; s
{
  "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包会失败。5 K+ L( ~# Y$ e
3、编码7 Z5 H3 \1 I9 q; L! \
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:; R" K! i+ t0 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
* I3 W( X3 V/ y  w) R四、调试# F$ Q* e/ m4 h! N3 ?% G1 F2 [
       单纯的开发代码片段的话测试和调试都非常简单:
" j( i: Y/ g+ m( F
  • 首先先自定义全局的code snippet。8 Q, @4 h) O# r
4.jpg
5 `2 }* t2 m" ^# W
  • 选择新建全局代码片段文件。) x: r/ H7 f# x
5.jpg
) T/ C9 L3 a2 L. j
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
      q4 G* w) `2 T0 P% d# C
6.jpg ( V8 J( _  d$ |! T% i
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    7 t1 {$ _7 y0 Q  W6 S
7.jpg 4 M& i* J+ g3 a( g! J) Y
       生成的代码片段如下:
. ?) J3 t! V2 P9 Y0 z! g, p+ 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;
五、打包/ V& A4 ?8 L' \7 L* x$ Z
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
, J: c1 W2 I. c4 g6 A, ]) {: H; j5 z六、发布
& B- p, [0 q! M; v       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
( B. U# s( Z& { 8.jpg 7 |" g: E4 ^! l
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
) h4 J1 F0 K- _& x8 k9 ^* R 9.jpg 5 Y4 x. f. O! c9 ^
七、结语9 a. P- i& t; \: G
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-8-6 19:07

Powered by paopaomj X3.5 © 2016-2025 sitemap

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