QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4239|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言8 M, E5 v& H0 Q9 @# Z
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。, t% y# C% H7 ]: \) V
二、环境准备5 F  C: l+ Y, z- V
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    7 N, I. R6 b0 {$ H( f& J7 \
三、开发者账号申请
8 U6 b( b; n: K8 S% [       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。8 K) f, |( L+ @; G& C
1.注册并登录 Azure DevOps
* V: ?6 J, K% C6 I2.选择或者创建一个组织(new organization)。
/ P7 ]" N: |1 J& G7 B3.在该组织下创建一个项目(new project)。
5 V9 ?4 f5 d2 v  O       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
5 _. t/ }4 Y6 S/ G% l' N 1.jpg
& v8 Y) H: O9 D9 q4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。: W9 n) l# K( H0 J. y) C( M
2.jpg
& \, G  D0 g3 A0 ~# M- k- C5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
/ h1 _' d" S; ^三、项目搭建* d9 g; D* A( |* u
1、项目初始化- b' [) Y& Y, {6 X
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。: m0 t# T9 _( M& U
3.jpg 4 J" _" D, O, I- V  c
2、项目改造0 z' w* D. H, Q- D& N
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
4 r/ m4 O+ {# x1 ^6 F1.将package.json改造成以下模样:
0 \. v4 `7 i  ?& 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包会失败。' ]+ d7 b" y% z8 r/ ]6 @
3、编码% c: E0 o0 [3 }: i  _$ A8 {; ~
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
5 V3 X+ k) P% w3 m" o# G5 v( 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。2 `, m+ X. k5 c" ]4 ]  j5 M
四、调试
& q# b3 J& y1 M  C       单纯的开发代码片段的话测试和调试都非常简单:$ o. D) z% V8 R) ~* n
  • 首先先自定义全局的code snippet。% a* m) a- o* y" ~  Q/ r8 ]
4.jpg 0 j4 C' \( Y) e/ I$ G
  • 选择新建全局代码片段文件。
    3 \$ }$ i  I" D
5.jpg 1 T+ g8 N/ l9 N& G2 i8 Y
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    , A1 M, r) `6 R
6.jpg
: `( a! C7 u4 |) ]* C( z/ ~
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    0 \$ ~" v1 I4 y0 f! o+ C! O2 \
7.jpg + J! W  z1 U% K8 k8 y
       生成的代码片段如下:. a+ w# ^( L1 @4 H, O; d; 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;
五、打包
& }  Q) T! G5 }, g2 w; M       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。  `5 S6 u. V  G: Q  S# p
六、发布
6 Q3 \' }6 V% ~7 P( A7 m# L7 |       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
2 B# h. Q- U( Y9 w( k 8.jpg 1 d1 }/ b1 @( ?: r# Z9 G
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~2 ^, V2 T% q% i* _" N6 K
9.jpg / |) z# `# T$ z' V7 B
七、结语0 p0 I0 Z" d( F; k5 W) y
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-24 14:53

Powered by paopaomj X3.5 © 2016-2025 sitemap

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