QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5141|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
; x) L8 f* C5 y3 }6 j% e       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
8 t' b6 Z3 l$ {, I二、环境准备1 w. |4 S. B4 O; f
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g  ^9 z7 B1 X) |- E; ~/ {
三、开发者账号申请7 O$ ~% P7 i4 k% Z2 I
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
* y/ n4 C' S  z( U2 x9 W1.注册并登录 Azure DevOps
, K, u: \" ~* k% q& ]7 O0 a0 J( d2.选择或者创建一个组织(new organization)。
6 c& u( ?  Y; ]3.在该组织下创建一个项目(new project)。
+ |5 t( u& W7 Y  y! E& z       以上三步都是为了获取开发者(publisher)的token,获取token如下图:7 T/ S# B6 Z. ?" N3 A9 X& @. O
1.jpg " J7 {# x& v: \0 m/ W3 d5 x
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
2 r# W* Q3 n2 c3 X; M! M 2.jpg $ c* i& F$ y0 e- e% F( L, z
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。! `' E0 f( C4 W( E7 _' g/ P
三、项目搭建5 E# P( _& F  y6 a6 P- M, E/ [/ m
1、项目初始化
; [( m1 T0 ~* C$ n" i
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。7 z# y$ M* N" _$ z7 m
3.jpg 0 Z7 X% ^/ F- J
2、项目改造; \; e$ E3 x+ L3 w4 _& Y  [
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:, D0 o6 V+ t; f" p
1.将package.json改造成以下模样:+ E* b& |- c- k0 F' L& K+ m
{
  "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包会失败。
( b# ]7 t! R0 I3、编码7 }2 g  x: N' W) N, d% B
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:- O: u# ]7 `9 g" l
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
& Q* [  `# ~0 y0 _4 C7 n# x四、调试5 S. k1 t1 s4 }* p& h
       单纯的开发代码片段的话测试和调试都非常简单:
' p% D/ c# e  G$ V
  • 首先先自定义全局的code snippet。
    $ @, G# ^% R8 @/ j; R/ x
4.jpg
, e" Q4 \2 ~) V7 K6 ~8 g4 ?/ I
  • 选择新建全局代码片段文件。, \8 ?' _' G% u5 T2 M& U0 L7 L. M
5.jpg ; k  Z6 I/ t$ P1 c3 H$ U+ R( N
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。' k! u; \3 G& f5 k  a2 Q
6.jpg ) i; x* t  s! g, Z$ a. G
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。  x9 _+ G4 y6 f3 D2 ~
7.jpg
7 x2 q4 q5 y/ F% S- p6 g       生成的代码片段如下:, S8 O0 e" G! p! R4 Y3 b
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;
五、打包, a6 R" u$ t- c+ _( t2 Q& s( S
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
, M  H" }/ y& T& d六、发布  ~, c1 X5 u$ Y6 q
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
& ~. @, b) m0 h. T 8.jpg
9 M# P) w! z1 A2 b4 O4 ?       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~' M1 P+ o4 j2 H% U" p# R
9.jpg
1 ?* k5 J' t: r. V) H9 W$ O七、结语0 f8 I' Y  t( F9 _5 G4 |6 F% v+ w
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-24 07:34

Powered by paopaomj X3.5 © 2016-2025 sitemap

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