QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4505|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

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

本版积分规则

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

GMT+8, 2026-4-25 21:03

Powered by paopaomj X3.5 © 2016-2025 sitemap

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