QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5128|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言: \5 S1 O- Y! W7 p6 Q- e; v7 u
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。$ s6 O# K0 m& Y5 S; L
二、环境准备
; C1 N. D5 U1 l& Z0 s
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    + [& W$ D  H6 J4 \/ z9 i3 ?, L
三、开发者账号申请8 {* g( p6 K5 S: M3 R0 Y
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
& W& j" V1 j0 y: n0 ]# A1.注册并登录 Azure DevOps
) g7 u% R/ |+ w; H. H8 Y2.选择或者创建一个组织(new organization)。
0 q- I$ a. g3 o& x; v  s3.在该组织下创建一个项目(new project)。. Y" K& V6 K; U( ?2 M$ y
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:: C1 R) Z  N7 `( P1 G
1.jpg
  A( |  k2 A4 d. K# M0 V5 C5 X4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。  f6 s; i0 y8 D  ]' S, F0 B
2.jpg 0 k# R; O8 _- d0 h$ Y% r
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。2 f  i. e9 I. \% o- J! a4 m7 n
三、项目搭建8 ?) Y5 _* Z* e
1、项目初始化
  q; I' H5 q6 Z8 p; C
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    3 ?* e+ Z# o) F8 S. D( v
3.jpg
/ c( @: q: k9 H/ g8 d! B9 K2、项目改造- l7 s+ ], r: _8 k7 n$ x
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
: ?0 h. N. [5 ~; I5 L- a3 B1.将package.json改造成以下模样:4 O$ i- f- F; E( F. L
{
  "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包会失败。4 u# C& b8 o7 H' [  g# _. ^
3、编码, f6 t2 a! o5 `/ Z! O2 U4 w/ k; L. l
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:3 ~- u2 O/ {  P! c8 w
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。  M+ s* M/ }! a. M7 G- }
四、调试
  C3 \' Q) z( z4 p; _1 x       单纯的开发代码片段的话测试和调试都非常简单:
/ M( S5 s0 f$ c' P3 X- I* w
  • 首先先自定义全局的code snippet。" E% I+ h& a7 Y8 [$ a( B7 G
4.jpg
9 }* k( n; q, g, y) h' ~3 v+ z
  • 选择新建全局代码片段文件。# v1 Q( H$ |) N  O9 _" W
5.jpg
( f/ }) U6 k2 S; |+ s0 g0 u4 j! s# P
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。8 H7 v3 u% Z- q( f/ r% m, \' P7 z2 \
6.jpg 1 z9 I, n9 P* ]" m; ?1 A3 [% X* x
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。- g8 E) s" u- g# s
7.jpg
' V" F. @6 G6 |       生成的代码片段如下:+ d5 |9 H7 S# u" J3 h' p0 K/ g/ _
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;
五、打包, p% x$ F; ?2 A% j
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。3 J# w# m' M3 R9 o
六、发布$ O2 R. ?& u+ a5 U% X" z# C
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!/ c9 [8 Z4 ~: D- q) O
8.jpg 8 J: N8 B. {  y. @
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~7 |: w+ B# r3 V/ W, d
9.jpg # I1 H# T) w5 O& Z8 E# M5 z# X9 T
七、结语
! r- x7 t' x& \0 f  d       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-21 20:30

Powered by paopaomj X3.5 © 2016-2025 sitemap

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