QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5279|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
3 C; L' l% m( U$ W+ o- n       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
* {4 I/ n: ?$ O* W. C  R二、环境准备, r" x# ?  i; |& I
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g: s! E7 y) q- {- h$ N% S8 X
三、开发者账号申请8 F  a8 i/ v$ p8 T
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
' I# Y1 z% Z9 Z. |# E" G4 L1.注册并登录 Azure DevOps
8 a; X" g1 \( s- J3 E' L2.选择或者创建一个组织(new organization)。0 k/ i; W% u8 [$ m) W
3.在该组织下创建一个项目(new project)。8 F% j9 ]# X) y$ V; `; a
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
$ T  G/ w4 [; N) @- {9 ], o! A 1.jpg
! r+ E2 R- y/ J. R' b! ]4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。% B( U0 @% n, l3 x2 `
2.jpg
. U* R! i+ k$ `4 l5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
& l% \3 f2 U, s# h  N1 z三、项目搭建1 }1 L) `( X  f: c5 P4 |- B8 L
1、项目初始化
2 [1 Q9 t( [9 Q3 s- T, [5 Q& Y
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。  w" ]0 {0 f5 T0 X
3.jpg
/ d% t+ u9 C9 n9 [. E2 G7 T2、项目改造
, z" F* g) t9 Y/ c0 Y       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
6 V2 }$ z' p; G% ]# s8 h; f+ G1.将package.json改造成以下模样:
& O6 C# u$ F7 ~( e( }" I2 }
{
  "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包会失败。& U* D+ B% ]: o  r. I: K
3、编码  T( ?' L; D. ?4 h6 S, L
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
3 C2 F1 G- j4 p) Y/ [! T3 `
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。  r9 v# }' J- @) e, d: B' \  Q
四、调试& t( M& Y* z3 [2 ^- n+ n8 H0 s
       单纯的开发代码片段的话测试和调试都非常简单:
" z, G7 B& F* H- E1 g/ ^
  • 首先先自定义全局的code snippet。
    + ^0 @) l& d5 G2 E- S
4.jpg
6 A0 J3 Y& v& t. u6 z( t' T% Z8 _$ U
  • 选择新建全局代码片段文件。& E- f7 P+ x7 C7 _! ~9 S8 [
5.jpg 5 Y* H( y/ y4 d9 T% _
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。/ x# E# f* [; Q7 J
6.jpg $ a8 f. U6 C1 X' g
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    & X# U5 x# i5 A" m& v
7.jpg 2 v/ f# M1 a  @
       生成的代码片段如下:2 Y2 F$ X+ b7 H% S
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;
五、打包! Y3 h3 b$ u% }& @& j' f4 m/ y4 v7 m
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。9 u  s+ H0 d# ?# F
六、发布
, z5 }/ o/ i9 w4 D- N       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
; b( ~! d, N( W0 [# U2 E% s. ]0 } 8.jpg
/ x: w; a$ R9 x1 k$ B) q# r       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
: K1 z) s. e) B4 v 9.jpg . d0 K1 t7 z6 z1 Y2 c& N
七、结语  U, J( c9 l2 [1 J
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-8-11 11:41

Powered by paopaomj X3.5 © 2016-2025 sitemap

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