QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4303|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
' t4 {' `& j4 P8 T2 ]+ S       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。- _; D: ~5 N0 A! T' t1 e
二、环境准备) L, x) e: H1 b  j# r
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    . f: Y" a! _8 ^& a& N
三、开发者账号申请$ b, m- b# H/ `( J0 q& {9 z+ o) f
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。5 @& r3 m( {% [. p% B
1.注册并登录 Azure DevOps
* u6 R; H: }* A. g9 }& [2 B2.选择或者创建一个组织(new organization)。
$ Y5 G" X. l6 j" c5 Q6 `' [; H  B3.在该组织下创建一个项目(new project)。' \) P9 _7 V7 p9 {
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:1 F+ W& ?" V% r/ g: }( B
1.jpg % f5 o# A) }# Q" j" z) s
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
: N/ W' A0 ?% `9 E: @ 2.jpg
; o& t7 m# S- @+ T& y$ T5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
# z; a3 E. o6 N三、项目搭建
+ C& {( L1 h& G+ l* R5 Z2 ?1、项目初始化8 E' h, E6 D8 Q8 w/ t2 J8 i% `5 n
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    . L  `! q) W4 P+ [4 T0 C8 E
3.jpg 9 s+ g- t" q& F4 Z# V
2、项目改造
- u- Y* c' e6 T       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
6 K) R( a! |, z$ ^1.将package.json改造成以下模样:4 S6 C! W% F0 T8 B) s
{
  "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包会失败。
* G' ?4 ^: D  z* D. V3、编码
) h3 N) h- N1 Y3 P. v       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
, \3 [  K$ o8 l' A- Y  I+ T
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。# L2 F. U8 U' n& [- l, k! v
四、调试
9 d, g8 r% ~5 C( e: b4 d) j       单纯的开发代码片段的话测试和调试都非常简单:8 o$ i  A% w6 ~7 B8 ~" P! v
  • 首先先自定义全局的code snippet。
    - d# M2 N# T4 ]& H
4.jpg
5 }1 ?0 r7 k6 X5 u, V
  • 选择新建全局代码片段文件。
    ! z) U* x8 x. ^- h, Y/ M
5.jpg - S8 |& M8 Z9 \9 ~) m
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    3 X8 [4 h4 V* f# C; s% |+ Y' J
6.jpg 6 ^" H/ z: F0 Z6 S
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    ! ?! c. c) ]1 r+ y' n4 H9 g
7.jpg 2 \  A! E" J6 u1 g* i: E/ w. \" v, E# x
       生成的代码片段如下:
& K# m9 Y( T  J! W+ z7 r
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;
五、打包8 d" N5 [( m8 S! n, P" ^6 O: c
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
/ a; r: R' v" u& E9 Z  T六、发布  w+ i& B( m6 I* B
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
5 `( s; N: X1 n% B 8.jpg # J: K* s. s* |' [$ H
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
- {; F! ~! E- f' p 9.jpg
0 d+ F! H/ e& c3 C2 S& g; b* R七、结语
7 q, u# t# Z  A+ e* |6 e' _* H       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-2-14 09:25

Powered by paopaomj X3.5 © 2016-2025 sitemap

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