QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4284|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
5 O9 A/ f5 \6 Y       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
+ r0 n2 ~2 n$ r; t- C1 X二、环境准备0 w, |1 k* o3 J$ r2 R6 p2 N0 a
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g' R  ~" C: c: c
三、开发者账号申请
8 z4 a* ]$ d  r6 z! B0 R       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。% [5 w4 [" R' d! ^5 l
1.注册并登录 Azure DevOps- F- X- Z+ w. k1 ?+ [; L4 f8 }2 h
2.选择或者创建一个组织(new organization)。
0 B) a* p! n$ \3.在该组织下创建一个项目(new project)。
& i6 o3 r' P) E- y! i1 k       以上三步都是为了获取开发者(publisher)的token,获取token如下图:/ R6 e7 E( O% G3 R$ n
1.jpg ( f; A3 j0 g8 K
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
9 R. ~$ q1 H6 W 2.jpg 0 ?1 m$ u# v6 n" A$ S. f1 @
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。$ U, [$ B9 j# Z% \; [8 g
三、项目搭建5 D, ~$ U  G2 ~
1、项目初始化
2 z  u8 l; A5 {, N4 @( ^, c8 _
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。# T* I7 V4 e9 M1 v. u3 H
3.jpg $ s: R# S: [- D: W" O( [6 C
2、项目改造' h" d2 i/ e- [& ?* O9 o- H
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:0 i2 z! _; m6 S; u6 W0 j1 I
1.将package.json改造成以下模样:6 O  A6 y1 c# u8 h
{
  "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包会失败。8 \) w: n# W4 c: T! g
3、编码
4 K- F# R# ^0 z; o       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:9 o8 E4 z& P, ~  h7 s# o) H
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。- h( w4 h6 H5 R7 S- P3 t
四、调试
! h; f$ k5 f0 m. r0 Y       单纯的开发代码片段的话测试和调试都非常简单:
# l3 Y+ L$ W; }5 \
  • 首先先自定义全局的code snippet。
    ; G. A) W; y+ o0 u6 R% v
4.jpg
" ~0 D3 f6 [0 l9 b
  • 选择新建全局代码片段文件。( N1 `2 D4 ]* h4 w) U
5.jpg
) n# B8 l1 k% J/ G  d
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。" k- H# c% k! N9 [) }4 ~$ H/ H
6.jpg
) I5 x# ^- R: N7 b- F. v1 R8 y. [
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    % N% g$ u9 C* N; y3 ~- a9 L2 A
7.jpg
1 a/ R% s" L7 d) C: A       生成的代码片段如下:
7 Z8 Q3 g( E+ Z/ M. M8 T
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;
五、打包
5 d% G, I1 g$ @; Y       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。& t+ i: o2 K9 X) F
六、发布1 e% X6 T5 n  t# m1 x
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!; [, |$ l* a% |# [
8.jpg 8 `) {& k: q: O5 @  {, z
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~+ m' d- |) _1 @, z
9.jpg 7 o; Q/ Y" U% B+ n3 j1 N
七、结语
; T' f9 r' A2 h0 {8 h" s; D" l       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-2-9 22:16

Powered by paopaomj X3.5 © 2016-2025 sitemap

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