QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 2869|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
5 Y7 v' P& T+ Y5 y+ N1 o       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。8 O, \  d# |( O+ V: t0 ]' f9 q
二、环境准备, q- p* E6 q; c- Y4 H. C+ g' N
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g: p& C' N: o2 S
三、开发者账号申请. d0 ~3 h% A0 g
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
. ~# R/ ]; F$ @1.注册并登录 Azure DevOps
8 }; Q9 [; O  x( g0 E2.选择或者创建一个组织(new organization)。
9 P1 d+ K) G1 w+ Z* Z/ q3.在该组织下创建一个项目(new project)。
! w1 {# X' e9 |       以上三步都是为了获取开发者(publisher)的token,获取token如下图:# _/ C5 }$ P) R2 T
1.jpg * d* P+ H8 W2 P
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
6 I* m( w: R" @0 \ 2.jpg # j9 v; a& ^. N. L! I* }
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。* n& k# o& D4 O$ w- n
三、项目搭建
  F. w/ G2 S$ C* F& I+ [- y' `1、项目初始化
8 r1 J! l& r7 ~6 e5 E: k* n% b
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    - a& y# Y. }+ u7 t( |( w
3.jpg 6 y( d& l4 \7 h
2、项目改造
6 C. F+ j9 o, k2 x  Z       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
9 Y- D4 Z& b5 [$ {' S8 e, `1.将package.json改造成以下模样:
5 v- V* j4 Y2 A9 w' }
{
  "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包会失败。
. I; H# \, E8 D6 H! E0 }3、编码
3 H6 @( M+ A- Z0 N+ o) e3 q" C       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
3 _, q* n# p1 d2 w, O( p
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
+ K6 V9 m! I1 K  W# \( v/ s四、调试
. z2 z# h: s+ u$ I: M+ T       单纯的开发代码片段的话测试和调试都非常简单:6 y0 C: ?, M& p# k2 j
  • 首先先自定义全局的code snippet。8 a' ~) _! {$ L" H. k/ k
4.jpg ( n8 J" L; B: [
  • 选择新建全局代码片段文件。+ b! v6 e/ s3 K6 f
5.jpg 5 Q- o: m& v( \+ s: B% o
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。8 W& L" L5 G) o$ g# G
6.jpg
. r9 Q% o; V2 v
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。3 T! Q: X7 N* u6 |9 P! q1 W
7.jpg
$ K, r$ F  e  }, I  `7 f4 q       生成的代码片段如下:
; T6 f% y" h3 ?( 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;
五、打包" E6 V" A/ Y! C4 V1 n
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
& O) S- J; ]& g0 _4 h8 y" X8 Y六、发布# f/ L; X; D2 [
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
+ W5 D, [" K9 {* R 8.jpg
9 d8 [  v$ p( {" a5 K. D       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
& ]5 u7 G, |, M6 p$ f, H7 N 9.jpg ' V3 x' d) e2 z( m
七、结语
$ Y4 q% t8 B5 v3 y/ A: _       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2025-8-30 10:41

Powered by paopaomj X3.5 © 2016-2025 sitemap

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