QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4488|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言- |* T8 @& }& B
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
+ w5 L8 Q3 p. L6 x* T9 R" Z二、环境准备1 w7 |- y$ E* w9 R; d: K
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g: M, R; p0 ^0 |+ z! x* |! L
三、开发者账号申请6 l$ ~! Q" ~7 {$ B
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
6 P" d" Q6 E8 T, B- d1.注册并登录 Azure DevOps
. }% u9 y8 F9 @: T( k( w0 b2.选择或者创建一个组织(new organization)。- E$ w) c2 l( M0 c; U/ w) |
3.在该组织下创建一个项目(new project)。
% C# h! }9 R" \# N/ b- H3 f- b2 r       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
& f  M: [6 W" s. c, i" `* b5 g: p 1.jpg
) [2 Z( b* B/ ]5 R4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。1 n, U1 l6 i7 @% O# q+ S
2.jpg
( x( @/ a4 h, g& B5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。0 [$ ~1 O" _& v; I) q5 j3 e
三、项目搭建
% D: q3 Z" t' S; C# G4 S$ f. p1、项目初始化; {9 o& J" c% V1 ~! r) J- U( _
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ) r; A3 z- \, a! Y; c3 H* T
3.jpg
8 B5 l7 W  v! [" b2、项目改造; j0 Q" ]& Z" p. ^" {. U* p( y5 F
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:4 t  O3 B  y& {2 z* @1 b  t
1.将package.json改造成以下模样:
0 c" j5 T1 }* z- e
{
  "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包会失败。* l& R; a* y5 _/ w; x* U
3、编码3 e& H( Q3 J+ _. U' R7 H$ T+ X0 ?  E
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
( I1 s: W6 U! a6 f
{
  "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 c; M0 u. ]$ c* j* G( r6 L四、调试
1 y1 P' V: v% U+ v       单纯的开发代码片段的话测试和调试都非常简单:% G* j5 R: }  F7 v- u
  • 首先先自定义全局的code snippet。
    3 M; L! B' c* F
4.jpg
! G1 u8 q4 n" L" m+ n
  • 选择新建全局代码片段文件。* p) _' V  K! w, P! t4 @: ^& A- w
5.jpg : s' O3 l+ D4 x6 P/ d& O. D2 O, Q
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    % e( j! W" ^3 t- M8 B4 v
6.jpg
1 a6 R( ~; J& U! ~+ d  ?1 {! {
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    7 B% K% K! Y* w/ r
7.jpg
7 `( L: F" u6 {  V  i       生成的代码片段如下:
" y" r) |- z6 f4 k; ?
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;
五、打包& f& z/ p( D! k" W4 @; q" c
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。8 Z5 @1 U/ }' r0 @: q3 B1 W7 A
六、发布
% i" s; j5 K/ w5 e2 ]       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
' b" e: O5 \: Q; {8 s, p3 Y* d 8.jpg
5 e5 T! e0 p7 \/ w' r- o       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~  H9 o# U6 \# V) w2 \% A/ e$ U
9.jpg
0 t3 W7 @  g% |9 m" F& }1 I七、结语$ X$ t) d4 s) S: R/ K! v; z  ~
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-4-19 16:33

Powered by paopaomj X3.5 © 2016-2025 sitemap

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