QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4189|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言" z" ?6 }" _6 {% T2 p
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
& Z2 a! N) Q! i# n5 M8 w# D二、环境准备5 G& c. r# g! M1 j0 h# p8 x
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g. r! U2 Q' j5 }$ O+ n& `  V
三、开发者账号申请' g' O) j3 m; c& B1 Z' ]1 |0 G% g
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。! V# d) J3 t% Q# f
1.注册并登录 Azure DevOps$ M' S; {6 G" U* P
2.选择或者创建一个组织(new organization)。
& G( o$ i$ C! F$ a% U3.在该组织下创建一个项目(new project)。
0 A1 u4 ?% u6 Z, w4 W, ^! R& h       以上三步都是为了获取开发者(publisher)的token,获取token如下图:0 y# ]& h. G; s/ r$ G& G# A
1.jpg * u9 g1 p5 x/ x2 A6 D6 w
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
+ ^  F) B# W: g+ c* G( @- v 2.jpg & q# Q' e  T$ D8 V" k) A6 X
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。! m- c7 ^8 C: }
三、项目搭建
9 _. ]/ u; a! T' T) a6 h" n. L1 K1、项目初始化# m/ F; K9 F6 s: }. C6 I. `
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    5 |$ X; x: i  v; I5 G/ S$ {
3.jpg 5 P. n8 [, J% L- W* U
2、项目改造
: f* S8 q8 D* Q$ K$ @8 A% z       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:, N4 f2 H; V$ G4 H& F# V
1.将package.json改造成以下模样:
8 P: e0 x( _2 O" h' W9 s7 y  t
{
  "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包会失败。2 d; S; ^  t; r' V! ]4 [
3、编码5 X. v7 `2 p/ ]* }7 t9 I
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:: X4 }4 \1 T. c, Q
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。) P/ |  [, m9 {
四、调试2 _" ]" q1 a6 X4 N
       单纯的开发代码片段的话测试和调试都非常简单:
; U. F" k. o# u& C7 r  q" A4 l2 ]
  • 首先先自定义全局的code snippet。
    0 |# I) |  |- T" X1 p% O, U
4.jpg 6 g8 L- n4 \  x# N) @4 M- m: E
  • 选择新建全局代码片段文件。, Y* \2 N1 D/ Q! C1 W
5.jpg 7 n5 L* M, J3 @7 E' x, U5 x
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。! d: I! Z& ]1 l$ P- [$ \
6.jpg
$ H) I, z( Q9 ?# L( w9 Y0 J/ m
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    $ p( Q& A) d* r* Z$ u9 f7 d7 j0 N1 V
7.jpg $ Z0 ^- }- _8 f2 v9 d0 b
       生成的代码片段如下:# T; \: t+ j! s$ N+ [- B2 P
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;
五、打包
' a- Y; b  b; ]+ F" x1 s       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: ?" l+ k7 b' `0 O4 |6 ^8 Y! e# b; T
六、发布) w: c2 Z% T- @  l
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!  Z( N! J" z: c
8.jpg   r4 t) @7 o% t4 o' a. U0 v
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~6 u9 [7 M3 a( i$ I3 ~+ d
9.jpg
# j$ b$ R. G4 O% `2 v- v! z4 u七、结语) ~7 F2 U+ @! e
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-16 06:24

Powered by paopaomj X3.5 © 2016-2025 sitemap

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