QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4568|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
+ I* V9 Z5 q  O' l       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
. }9 S7 i5 Z1 `二、环境准备
2 S, `  K% Q& x3 Y: R
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    + N0 r6 v5 M, X$ |" ?+ D+ Y# i3 W" L
三、开发者账号申请& {+ L$ r3 l  v' \) ?
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。1 D5 ]& p2 B8 g+ J; H' y1 V
1.注册并登录 Azure DevOps
+ Q& V: H+ T2 V  |/ h9 l2.选择或者创建一个组织(new organization)。
7 c" R6 h% C4 H! ~) J6 M: h6 H" B3.在该组织下创建一个项目(new project)。6 m, x, }, Z( L: t
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
( ^/ U6 e3 z3 ]+ { 1.jpg
+ ]; r( e8 l  H+ S. P, K, T4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。) `! U, v5 J! d7 X4 J$ ?0 j
2.jpg 1 C1 z/ e8 b, m( B& B
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。! o8 ]" X. P) |# E5 j, A
三、项目搭建
3 K3 o0 [7 [. h4 I- S3 G1、项目初始化* Z' z+ J/ w5 W% ?
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。# h& r# x. C# s" T" T. E4 b
3.jpg & \( X& p+ p+ Z. Q, C, n. q
2、项目改造; r* s& c; ^5 Z9 l# _
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:" P! W( J+ L  W1 A$ U; h  I7 m
1.将package.json改造成以下模样:
: v) S+ @; l0 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包会失败。
/ _' o5 {* t( J+ ^+ z3、编码9 B6 U  `' A. Q6 C% E; p: N
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:0 m6 G9 c& w8 N+ |7 s  ]
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
' X1 c5 j0 _. N; ]2 N8 o四、调试. w' i& K1 V, {3 |4 U
       单纯的开发代码片段的话测试和调试都非常简单:
: y3 K3 J9 a. q$ _- u/ f
  • 首先先自定义全局的code snippet。
    - C/ r% l$ |. Q9 d
4.jpg 6 ~* e3 }+ t1 Y! x3 O0 k
  • 选择新建全局代码片段文件。
    5 I: m, N; S- v" ^
5.jpg 2 k; I% ~0 t4 r- t# v" I1 T
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    ' U* z9 ^2 }3 X3 S1 a9 L
6.jpg ( Z9 o6 s$ w% i# `# k! O0 X
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。1 C) t( P2 c% a
7.jpg & P- ?/ n. `9 M% ]2 q
       生成的代码片段如下:
' d" X5 v5 V3 I- 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;
五、打包
' {0 o" U# k9 j! V- M( d0 v       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: ?7 H: C: [2 g
六、发布" L2 l) e  ?3 d, D# |
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
+ A2 |2 m' U: E9 d3 o$ K9 a, M 8.jpg * Z& F5 Y9 ?4 u0 K9 _( z
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~7 r: Q7 ^7 |. x' W
9.jpg
( j& w3 E9 H! E7 Y6 W9 f七、结语! o& H" M. j2 q2 X1 W' o5 }; F
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-8 13:06

Powered by paopaomj X3.5 © 2016-2025 sitemap

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