QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4971|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言: t* r8 v/ e% ?! I1 @1 {
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。, v4 J6 O3 m* |0 u' ]- U
二、环境准备
6 A6 A; W) a% p/ D: H) j
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g/ z5 q8 b. D- R( H8 X. W, m
三、开发者账号申请
* X7 z) d$ u, e       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。6 i7 X6 D1 a2 Y+ i9 a
1.注册并登录 Azure DevOps& Z1 \7 ?8 P" L9 d8 ^& U& l
2.选择或者创建一个组织(new organization)。- Q7 j& M* z: [1 y
3.在该组织下创建一个项目(new project)。
& @' q; _1 N; n. P* ]       以上三步都是为了获取开发者(publisher)的token,获取token如下图:2 q( y! w2 o; x) h: K& I8 s% S/ D
1.jpg + g% {$ A% P) @' p2 r8 C& h
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
+ g7 j& b+ j7 R* V 2.jpg
# |/ w$ m1 a* d& d* g( _5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。# ?5 J; s  f* f2 D
三、项目搭建, @! M% E( R0 ^' ]& _6 q" d! N
1、项目初始化
* [& {+ M* i  Y) ^3 p
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
      X$ c8 G) b! I) M2 ]" `% Z
3.jpg $ q9 ~  F, a% B- Q- b. Z
2、项目改造2 \' S) q" R8 m
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
" e/ h+ V! h* g: r1.将package.json改造成以下模样:! q" P. i2 C2 d
{
  "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包会失败。
  o0 F* k- S+ M: f1 y% Q  c* H# a3、编码% h0 l9 [/ {7 C! A" O3 L' Q
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
% h0 E- m- [2 |/ P
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。6 ^/ ?- a& U3 Y$ r3 b- o' D: n, X
四、调试
3 K( }& m; s+ W1 P       单纯的开发代码片段的话测试和调试都非常简单:; S. o( W- d% A" X7 ^. l: E1 E2 L
  • 首先先自定义全局的code snippet。
    / g5 A; C% M8 H4 b: {# Q
4.jpg
0 Q8 u5 L( `; g% y. A
  • 选择新建全局代码片段文件。0 b: {3 H8 Y' S1 N
5.jpg & x5 F/ J  m; m% U6 k
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    ' d4 h( X" K* ?5 g* V; j) Z6 s
6.jpg
1 C2 u: J: y$ o0 U. t5 w
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    4 R3 j9 r9 B7 n
7.jpg
4 z: i$ s0 {' m6 N' F- n       生成的代码片段如下:
3 y) O- O9 h# T! A& g
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 {) _; D( ?3 R* Y* ]       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。* {( r! g7 V1 K$ G9 u
六、发布
7 O5 _: p6 I6 W' t1 G- z  W7 }* x       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!: k, G1 N% ?; o
8.jpg ) ]) `1 S3 m! `0 [
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~: [" P. i3 d2 n
9.jpg 9 p" u, e6 H1 ]- W
七、结语' @- J' O. X3 ?3 [# _6 U) g
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-4 00:18

Powered by paopaomj X3.5 © 2016-2025 sitemap

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