QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5287|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言8 Y2 Z# m1 P6 q* G4 F5 l6 w+ q8 E: ?
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
5 b' F  X' c$ t- {: M8 Z) J: x) o: I8 b二、环境准备
) D) J7 l7 O0 |# Q- S" ?! o
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g6 \+ J# W$ i0 c
三、开发者账号申请' P- d- e# Y( {( {9 P
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。9 V. w$ B% `) e/ _0 \1 h
1.注册并登录 Azure DevOps
2 i1 |" _, `+ p4 v7 U2 D, L2.选择或者创建一个组织(new organization)。
* Y' ^- C- f% }- V7 H3.在该组织下创建一个项目(new project)。
' {1 f! V- }8 o  Y" Y' \/ Y( ^/ ^       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
. Y; H1 d; ]5 G$ j: w 1.jpg
% i! Z7 R0 f: {/ Q7 d. [4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。3 o3 W. \& C; ]7 K
2.jpg
& g- G7 m: q+ e5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。1 x( e: {  R, {; d) r" r& N7 m( [
三、项目搭建$ f! ]# p0 ~2 j1 D1 n$ L4 g
1、项目初始化
6 j1 G* V9 O% f
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。& R& a; ~, Y$ r& ~/ ]8 ~) A
3.jpg 3 T2 [0 \- D$ ~5 }7 M8 v
2、项目改造
3 I9 f8 |8 W5 Y2 ?" j& O+ c       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
; Y# \, j2 s0 {* F2 C3 t  D' n1.将package.json改造成以下模样:0 D* y$ E) v2 m, B* ?/ J
{
  "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 e" j$ l# U) {2 G, y9 S2 m
3、编码8 z" W) v( T( i1 ~2 B# E( v$ ]
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
: P9 p. ^2 M, _$ S8 q; ]0 g
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
* y: I4 U6 I3 s3 B) ^四、调试; U- i* o% L( U' [0 ]; L
       单纯的开发代码片段的话测试和调试都非常简单:
8 q7 b& g/ w5 F# C8 H
  • 首先先自定义全局的code snippet。
    3 j- f, W0 [- \7 x- I4 M
4.jpg
; P# `) W3 u& U
  • 选择新建全局代码片段文件。
    1 m% `# M% `: Y
5.jpg
$ L# h$ J' g# X2 {# m
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    ( t5 Q8 S* {  K! W& s
6.jpg
0 P# q3 H  R' M: N/ v3 L' D) d* o$ a
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    0 j7 G3 o7 _0 I
7.jpg ) p, S& m6 H: w/ l- d1 |) p& h+ I
       生成的代码片段如下:$ U* H9 w% M- N" z7 k
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;
五、打包% h; M& A  S+ Q
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。7 U# U& C* ?; W9 p. j/ c2 ]
六、发布
2 @% l8 B. s% W  w0 V       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!: ^8 f, i$ r( {! |
8.jpg ! m8 |- J& [$ P7 X
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~: R+ i* D* X, q$ X. p; N# h) _
9.jpg
5 n1 w/ J* ]5 z9 x3 |% o: B" {* r七、结语+ t/ b  r3 |4 R0 s+ [( Y  ]/ @
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-8-12 22:42

Powered by paopaomj X3.5 © 2016-2025 sitemap

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