QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4219|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言- L2 L) Y9 m. U' J; A% E% K
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
# x! H! z7 E* O% Y" t7 u/ n) j二、环境准备
  K- ~) Y8 a/ q! l2 Z( l) Q6 y
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    1 Y$ L* N- X6 c: }, g1 I( W2 F9 I% a
三、开发者账号申请
* n$ i3 @8 ~# g7 i1 \       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
& }' e- z( q1 o- S, V' N. ~1.注册并登录 Azure DevOps
  H9 s& F  O  _  X. i2.选择或者创建一个组织(new organization)。/ ]/ h# L& m1 `) O$ h
3.在该组织下创建一个项目(new project)。& }- [2 B1 \' `3 I: L0 g7 c
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:) v4 k) s" x9 k5 M$ I; c
1.jpg
0 R/ B. U! F) X! w4 I4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
) Z$ _' n3 k1 _1 ^6 q/ W 2.jpg
. `+ a  _# N0 F; K2 u5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
" R0 H4 I: G! ?8 I5 t1 x三、项目搭建' h! H, p: ]: h1 b  V
1、项目初始化0 i2 N5 ]. ]+ G0 `. z: z, e
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ; m! K+ y; V8 E' Y# z- W: u% d
3.jpg 0 O  K. N- N1 X+ z, b. `+ _
2、项目改造8 Z1 m, r$ |4 l9 z$ k! ~
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
; Q0 k6 D" ^$ s- ^2 d4 J/ [6 S1.将package.json改造成以下模样:; ^: V( d; S: R0 G- Q
{
  "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包会失败。
' A* t2 ?. [, ]( F! w0 j3、编码
+ i' g1 |- P* B+ b! |% b       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:4 X: h: z3 C  l2 P3 v6 W- E. f
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。& w8 F+ i3 I2 p, E& l- H
四、调试
' f4 ?/ G! j/ g" e' a       单纯的开发代码片段的话测试和调试都非常简单:: b+ |1 A/ M$ g6 ]( t/ D
  • 首先先自定义全局的code snippet。9 }: I6 x; }' l6 `) Q
4.jpg
5 w4 h8 J% G9 j/ t. N/ E
  • 选择新建全局代码片段文件。
    ' G2 A" f' ?- O$ S( v& F6 x
5.jpg
) n2 I6 Z  ]! U- s% k: e
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。$ A+ ]/ u6 a  T+ @9 d) N" R; q" T
6.jpg
# g. v: b' j) T2 c2 ^
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    , T' T* ~. h2 X+ P( e
7.jpg ) t8 a5 E& ^  S+ \
       生成的代码片段如下:
' Y; O* k5 N$ R9 x# r0 O* D
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;
五、打包$ j  ~9 x" s. Y3 E0 T/ Y
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。$ @: _8 [3 y. d2 `
六、发布$ x# w4 p9 {$ d) i2 I9 Y
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
6 }6 W2 O/ x) Q5 `+ e2 x 8.jpg 8 _; h7 ~6 f, [% W- n) {
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~+ g& o3 @' Z  n/ [( w, C1 ^$ ?
9.jpg
! K# v  j. k  i; k; Y! [七、结语
2 o$ g) `$ |8 T& |! v8 m: B       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-21 21:20

Powered by paopaomj X3.5 © 2016-2025 sitemap

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