QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5026|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
2 ^# i  x: \( K6 p! t* }# Q       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
6 y* k# i) A# K' s1 ]- H二、环境准备. |" i3 E/ y+ _* n2 ~: K$ S
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    0 n9 m, }. c* n
三、开发者账号申请
0 `+ ~1 s  d; _' K. F! w1 F       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。5 n0 ?/ v9 f/ L2 W
1.注册并登录 Azure DevOps0 h( @6 b: k% Z2 n) w- L. y
2.选择或者创建一个组织(new organization)。
( E+ M3 V5 J$ ]" r7 T( h) i3.在该组织下创建一个项目(new project)。
: u3 l4 _) x' T       以上三步都是为了获取开发者(publisher)的token,获取token如下图:! K% {  K6 r) b7 C( c: Y' Z
1.jpg 2 u/ n, j# `' [: e+ _1 |' g
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。# m4 \# w  w4 H/ ]
2.jpg
" C! b2 p9 c) d0 ?8 x" H5 F- i) z5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。  m4 E2 u3 O; [0 c0 ~8 o8 v" r
三、项目搭建5 V+ Q' ^/ h1 ?- F
1、项目初始化) F' |6 J1 S3 E( ?3 N' h' e4 D
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ! v& p2 ?8 {6 }1 @
3.jpg
! c0 y5 N* p0 I1 J2、项目改造4 s1 U$ j% t! m0 B9 Q
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:0 r. y. r* ]" b$ ?' ^
1.将package.json改造成以下模样:* ~2 e& [, P3 o2 @5 U! ~' r! E
{
  "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包会失败。
7 w, `0 z! ~$ q( w! P6 j3、编码/ W2 X# V4 I- p) Y8 i
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:5 [7 Z/ }% V' B6 }3 w7 L  h% R
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
2 Z( l' n6 V9 d+ s- ?( T7 W四、调试; y+ K. @5 X1 X  J4 {
       单纯的开发代码片段的话测试和调试都非常简单:
  ~4 S1 i2 T# J3 W. e# R* }. s
  • 首先先自定义全局的code snippet。
    # u0 i9 `( \9 ^/ b
4.jpg
9 |  ~2 s# o3 T
  • 选择新建全局代码片段文件。
    ' `0 R. `+ A+ E
5.jpg ; h- _* J' S8 r1 A3 D
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    ( q. j/ o& V9 S# o' q3 \( X' W
6.jpg 5 C1 N1 [) E3 K
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。) q% A4 R/ f  E# d/ i+ z- C2 C- D+ \* v
7.jpg : a5 u2 {9 ~: M, Z
       生成的代码片段如下:9 J# d% r: r# K* P( `, F/ e$ H
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;
五、打包
/ {5 b1 j' u4 F1 o       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。& d& I  o/ X. @4 G
六、发布7 v) K, y9 o1 e9 v
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!6 i# Y" k7 |4 s2 A2 P* Z7 `
8.jpg
8 U3 m: p' i" }1 {& c7 m  \% ?       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~" I- p6 Q5 K; k% Z& M; Q
9.jpg
) f" Q2 Y4 ?. Z1 h2 q七、结语
6 y1 V9 d+ F+ }6 K       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-8 19:08

Powered by paopaomj X3.5 © 2016-2025 sitemap

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