QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4181|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
0 m& a" r) @) {( ^& G1 U       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。) u8 d" z' A' L# j$ u2 b
二、环境准备
/ }2 ^2 E7 t, R2 w. y8 l
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    % v' d2 q! L7 O' y8 R) M% }
三、开发者账号申请8 n% V# h9 F' _5 [% ~! Z9 {
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
! B8 O# W. O+ c, b$ Z6 N* ?1.注册并登录 Azure DevOps0 H% J* w4 g7 g/ }
2.选择或者创建一个组织(new organization)。
8 X) R( h: q4 E/ k; U3.在该组织下创建一个项目(new project)。
" R6 q. F" C9 s9 E( H- ~: J       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
, Y7 A1 G; `6 l+ E& y) y 1.jpg ) Y% r* x2 S; R; v4 [- ~
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
+ q1 k7 g, R5 W6 g0 _+ o 2.jpg 4 p1 b  {9 |' i3 F7 E# z
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。7 _6 K$ u0 W  M5 ?: J
三、项目搭建
+ ]$ o9 d0 `5 ?; q5 z4 t, j1、项目初始化
: O6 C3 |1 f  U- Y1 U) g' B
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    2 ?2 X: N; n5 v
3.jpg
' Y  q! G$ o$ L0 r. t4 u# X! R- M2、项目改造
% C1 r; {% ]6 V       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:# Z, K* e% W! w9 a4 q! i0 Z
1.将package.json改造成以下模样:! m3 g1 }( c3 X0 ^, h3 B6 M" v
{
  "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包会失败。
7 c1 N7 ], h; p0 ]+ k! A! y3、编码' {8 j$ ^9 {+ W; W
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:/ b3 o5 X& U( J: \: w+ D# @6 S6 Z; y# 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。( b7 R  ~* L, N' e4 q7 d, }
四、调试
7 r. X8 u2 A# l' M& I1 H. |       单纯的开发代码片段的话测试和调试都非常简单:3 U6 I( s- T9 M% w7 S  \
  • 首先先自定义全局的code snippet。
    * P6 s- T9 B9 V/ i
4.jpg 0 e' V  |+ i  T5 z
  • 选择新建全局代码片段文件。
    $ C$ _- t9 ^* Q
5.jpg
6 s" g. {: A' S) z9 L0 F+ |: X
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。4 M  R5 l2 G: E6 b1 W( ~5 \
6.jpg $ t% H! f* p' ~, S# r# N  H
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。+ x/ u5 G. c; U$ R& ?* g  B
7.jpg 7 z7 M# n" T0 e' H( N
       生成的代码片段如下:
% \% {1 a/ K( X: E' u) |
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;
五、打包
" \9 i" {% o5 V" [       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。1 \" D  R1 \. B5 x, t/ H! S
六、发布
2 [. e' [7 l. \  a       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!6 _) h6 L% M: {/ U* O/ ~; j
8.jpg
6 s1 N1 e7 M* S7 Y0 [       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
+ S( e" i& ~& { 9.jpg 2 k! q- l( {3 v" |
七、结语
, }! x8 Y, z2 a       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-14 10:51

Powered by paopaomj X3.5 © 2016-2025 sitemap

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