QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4379|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
- P0 f( n; ^7 T       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。% [+ y+ f) ?4 h
二、环境准备8 Y; G+ S0 L( D" P0 ]; I0 _" \0 {
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g9 D- ^) d: m* d" ^" F
三、开发者账号申请
1 U/ F' P* ]" P; G2 U1 ]/ ^! t       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
; X9 }8 U" w$ s: }* v( F1.注册并登录 Azure DevOps. T% s0 I" V9 a! p9 @. t
2.选择或者创建一个组织(new organization)。6 ]+ \1 |" {0 k7 e* M  c
3.在该组织下创建一个项目(new project)。
" C+ c' ]2 T4 y5 T. }. T       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
) j; u* [- V) y8 C  S* ] 1.jpg
+ z& x  w* l% Q; B) x6 a4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
: W3 j1 }4 m" R# |% E' B9 } 2.jpg 0 R" d- n6 [% {3 `$ F+ S
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
' A( h* p: w2 s+ N6 A4 [( ]三、项目搭建- G7 P0 q* J/ Y: a* D& z( A
1、项目初始化
5 B2 F+ g% U4 I. j  M) D
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。) k2 w. Q& J1 D" R7 L
3.jpg 8 s0 k6 ]- c+ d; v9 R
2、项目改造
; u& y% P* c3 E4 f% g% Z2 `       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
* ?. |# C2 \4 _. L: L1 E1.将package.json改造成以下模样:9 w7 ]# O% j: Y6 N7 l
{
  "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包会失败。
! E! j7 s( y9 x9 y* C; z3、编码
2 A7 n1 m0 {0 I. ^1 l: f2 g4 k       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:- U. w0 w. C& J2 q* y- C
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。3 J, k3 G. u& B$ j8 ^  \5 d
四、调试
& v/ ]) ~; g$ r5 l9 {       单纯的开发代码片段的话测试和调试都非常简单:
( A/ p0 f" R+ `/ {3 t& k+ y
  • 首先先自定义全局的code snippet。
    * `3 ]' h1 K6 g4 r% B. Z
4.jpg
; C- j& n9 L- [$ q
  • 选择新建全局代码片段文件。
    7 h* O- ]1 S- B) l. g' U
5.jpg
' u7 ^! X" ^& G- Z) O3 h. {
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    ; P7 @. T9 R6 `9 s/ M9 u
6.jpg * h' i& Q/ k' {0 B. J7 ^( D8 E
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    % ~7 _/ H% J3 q+ |" n; G# S+ M
7.jpg
( X. \2 Q- o. N  U3 R. _       生成的代码片段如下:2 `( [; G! z/ B' @5 {# f; O* H( Q
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;
五、打包. ^: ^* r3 k3 o8 F* |4 U
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。) N9 T2 f& d8 x+ k
六、发布1 G; X9 ?. i" ~. G+ F
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!8 l5 F! B: E4 x6 w
8.jpg
% n+ w' J. e7 p       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
9 P3 ]  M3 S% `! m% y$ w' R7 g 9.jpg 4 `( r$ m; o* t5 H. z# P# ]0 a
七、结语
1 y& B$ w) R4 M% O7 I       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-3-10 01:18

Powered by paopaomj X3.5 © 2016-2025 sitemap

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