QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4274|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言9 D  j, I) m3 @
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
2 G) U  _1 P2 V3 M. T二、环境准备
/ i: k- n. r6 q* m* S% W# {, Q
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    1 K) i) F$ V6 h0 d
三、开发者账号申请$ |3 y6 `& c  l' @4 C9 o
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。& u, s- M8 S0 c: C. }
1.注册并登录 Azure DevOps: m) o6 X( m& [" f: g1 N8 [
2.选择或者创建一个组织(new organization)。& H0 q3 Y$ p7 {. H9 j) p
3.在该组织下创建一个项目(new project)。2 m- A/ v5 }+ ]! g
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
( n- T* H7 Z$ D/ {% W 1.jpg
9 U0 G" P" c! ]5 }% w9 B4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。% B, D% d' c1 J' X
2.jpg 9 Y" H. t& C0 t  G! s3 k
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
* z9 J' K# M9 q& R) u三、项目搭建
7 A& T4 d1 m- U- ~6 c1、项目初始化2 W- z! W# [5 M5 U2 j
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ' e+ ^1 [+ d/ l  c3 U  ~; s
3.jpg 0 _7 Y3 J+ z4 g+ R9 L7 I* Q8 i: \
2、项目改造; _: L* M3 R' c7 c! g' v: F0 x
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
/ ~# h' {  q0 y. I! `1.将package.json改造成以下模样:+ O( l" v* `1 x3 ]5 n
{
  "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包会失败。! G2 W: g4 T2 ~, B% g3 }/ u; R
3、编码) r# ], M6 \5 g: \3 h6 F/ U) n
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:0 V! |' W; C: j. m& Z/ Q  y4 v
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
/ l1 z/ j. J4 Q( B' B1 W四、调试9 k, F) u9 b6 `5 K. ?' v9 |9 ?5 j
       单纯的开发代码片段的话测试和调试都非常简单:# O/ }8 B) K2 N6 ~$ I" ]& h
  • 首先先自定义全局的code snippet。/ I5 V5 l3 \2 {& E
4.jpg
6 i% j, \5 ^& Z7 _
  • 选择新建全局代码片段文件。7 _* v7 d( D# D4 L" ^  }
5.jpg 6 w& _! j) f0 n* c# G
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    6 h( G: ?% v2 a% k
6.jpg , D7 @2 k' b& f8 L$ N3 ?
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    ( S. m* b: s" y: |6 \, u
7.jpg 7 f$ f5 p7 W3 T2 ^- p
       生成的代码片段如下:
. W0 e! N; i! b3 z* C$ W5 O
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 m+ U9 o- T# d# x% l4 x       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
; e$ k& q7 S; y. M  V) X六、发布
0 ~! i% Z, |6 R8 _$ E       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
; Y. p5 l6 f' }. G: Z9 h 8.jpg
: W+ \! _$ d; @% K4 o1 l$ x       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~- P9 E2 p9 e& U  `
9.jpg
* N. A) k3 Z. F七、结语5 L- Q4 I' |/ s
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-2-6 02:15

Powered by paopaomj X3.5 © 2016-2025 sitemap

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