QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4324|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
4 y9 K; H/ T9 H. `       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。% @5 d) |/ I( s6 \% @4 n" A7 Y
二、环境准备
5 ?% \1 |  b' v' d
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g8 ~* U2 r/ i+ W2 p# q/ N+ z8 k3 k& r
三、开发者账号申请
5 n3 [- G+ I" X& c( l! i$ k1 E       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
0 b! W" `. d& {: y2 b1.注册并登录 Azure DevOps6 {% N+ p' C/ ]; |) I  S
2.选择或者创建一个组织(new organization)。$ Y8 d  f& D" E: `5 O. C2 X$ l( [
3.在该组织下创建一个项目(new project)。
: X: S2 R' L: |% C& L4 Q       以上三步都是为了获取开发者(publisher)的token,获取token如下图:* w5 P( z# ^6 E
1.jpg
  H0 _) P" ?9 o9 ?4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。  @5 i* O& W  u
2.jpg
1 h& n" T  ?$ t7 Y: q' m5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
3 H4 w- i/ [$ q* H三、项目搭建! S- v9 H' T1 k! A( V
1、项目初始化; d: b2 Q+ k9 d1 ]% C+ m% x
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ! ^0 L3 l/ e  W" ~% x& O) ^6 J+ t
3.jpg
. @3 D: J$ q3 x2 Q  j+ U% Y2、项目改造8 C( R6 e- D/ m
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
2 @5 S0 j7 M* Z. [1.将package.json改造成以下模样:8 x2 v  ?, s  S  u6 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包会失败。
9 Q( I7 U% T4 f' {+ [$ h3、编码3 h, [- f% Z& o- `& j" i
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:; B' l& t$ V3 T0 N) y- z  M/ t
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
. A3 n' o$ ^7 A& X' O* G四、调试( Z$ x5 I9 _) u! j
       单纯的开发代码片段的话测试和调试都非常简单:
6 ]1 o$ ^$ f* ]$ z/ t$ o& Z- ]
  • 首先先自定义全局的code snippet。
    1 w8 B6 v( b5 A8 y8 r" w
4.jpg 2 j# C. S6 c" p7 ^( n( m
  • 选择新建全局代码片段文件。
    2 [9 r' m) F4 o9 p9 S5 N
5.jpg " o+ f( {# B3 p- ?
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。8 S' Y: O3 F" c! u
6.jpg , R$ Z9 i$ j/ @5 E! U
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。) I" i3 v2 H: X! `
7.jpg ; Y: U- X3 f, Y2 m; w& ^. p+ B4 S
       生成的代码片段如下:
/ [% s, W7 m9 g8 |: r
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;
五、打包4 r, A" A4 {) s3 I2 K# V. [
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。2 `* G# V2 f9 A
六、发布
' m7 o) Q4 `/ ^5 w) O       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!( d3 K2 ]5 P  v
8.jpg 1 K) |/ k4 }7 v. q9 G
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~2 M% ~5 E8 _- f: ]
9.jpg
  ]4 V  d1 a" Q3 O# h, T七、结语
* X2 h7 r  G$ e6 G) z       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-2-21 01:04

Powered by paopaomj X3.5 © 2016-2025 sitemap

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