QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4983|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言( C, S0 _6 d. g
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。6 k; K1 R7 w- e" }
二、环境准备% E5 x& Y/ o9 m6 `
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    0 Z0 c$ e  V9 ^6 k. x
三、开发者账号申请
" {1 n' G2 o' F       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
# ]& I1 I$ N8 n7 c& J; S' e1.注册并登录 Azure DevOps& U2 u$ e. `" L" N% H0 T
2.选择或者创建一个组织(new organization)。
1 k8 \* m  M( q1 q! [; F3.在该组织下创建一个项目(new project)。
4 ^( \. k& [  x: {9 L1 L       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
+ B7 [  E/ l0 C3 _0 t 1.jpg 0 N9 h+ Y% Z" a; J4 [3 }. D2 l
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
9 R0 {. w: R8 P' o6 E1 G( b; { 2.jpg
6 d2 c# y' n7 r; S" x5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。# D. C4 n! J& c; Y# I% A7 y# e% \
三、项目搭建
# F3 _! U* \* ^1、项目初始化
/ _/ F/ a2 ^6 t2 H, q0 B7 Z/ B
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    1 z# f- O: Z* Y7 r' Q& F8 s% h
3.jpg 2 c  ?4 V4 R. m2 u% y- q+ |: V8 |2 v
2、项目改造: a% s! a) X, [
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
; K8 K; S7 L# E1 i1.将package.json改造成以下模样:( I8 W" W4 w$ _/ M# t& d7 N1 K
{
  "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包会失败。
& a% g7 N4 J3 W' i0 r7 U3、编码
0 O  a( u7 n- w$ Y       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
3 A; N! m, V! X2 }, f+ }  k
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
  k, X. l# `; J  s$ x$ o5 C. y0 P四、调试
0 y- [* s+ w0 b1 [& u       单纯的开发代码片段的话测试和调试都非常简单:+ _7 K3 X; e4 |  v3 D6 R
  • 首先先自定义全局的code snippet。% ]( m" |% }' i2 P8 p2 S
4.jpg % J' z  o1 z6 f
  • 选择新建全局代码片段文件。+ y- r& [: M' f: d* o
5.jpg
+ L: ]( p6 V- ?/ y& B$ V4 u- U9 c
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
      w6 a6 A. Z5 G# x1 p: @& y
6.jpg
( w5 Q2 C6 F1 c! q$ W
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。& o# Z8 h. i8 H) h1 |# r2 g
7.jpg 9 X0 P2 X2 M; [' J. |! d  S  L  K
       生成的代码片段如下:
$ e- M$ w$ I9 j, D" l! M
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;
五、打包
, F, R8 m; b1 ]6 o$ M; v       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
1 G0 n7 S8 ?. x) Y( L5 u& u六、发布
! E  l3 ]! y4 Y3 J+ |( n/ c       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
7 O. R& {( n- R 8.jpg 3 g6 E- C4 z+ t
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~2 n$ L3 [( w5 @6 l
9.jpg 6 |1 s- f# o# R
七、结语
& _* {, g) |) ]' M- C       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-4 22:34

Powered by paopaomj X3.5 © 2016-2025 sitemap

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