QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4775|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言  O+ ]' D" [0 W1 r! w$ _  {
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
& X7 C2 ~5 l" U二、环境准备
, }# q1 u, v( [0 |+ ^' ?
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g9 y  U) n, Q9 {* i/ a
三、开发者账号申请' L  T* n2 _" g' y9 J- h
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。* i3 w, l9 l' P4 j! G
1.注册并登录 Azure DevOps% f$ c/ q" H: |1 u. t( Z  ?( X
2.选择或者创建一个组织(new organization)。
% i; S3 x& E1 n* z3.在该组织下创建一个项目(new project)。: b1 B: c6 M! k  c3 W9 C6 c" p
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
- H3 a/ G  ?/ @) f/ @" j! U 1.jpg 0 R5 i1 {9 m( j3 f, [& }
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。+ G; k1 W2 c! i. S9 f
2.jpg
1 w- C* l. [* S" S: q. u% N5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。1 L8 U; G1 j" s& t6 n
三、项目搭建" l+ e- P2 d( s; R
1、项目初始化
5 q# \0 P  \! G6 [
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    , ^2 @' c/ W1 a
3.jpg
# K/ ]2 @' \6 A2 x  P- g2、项目改造6 T& _6 g. [3 s! M6 C0 {
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
3 G. Z4 R9 c# u$ `$ K& J; _1.将package.json改造成以下模样:# I. Q% H: a) I3 q: ?
{
  "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包会失败。
9 Z) \% P. [9 ~3、编码! R$ h7 {: `$ A- T- R
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
9 F( T8 f2 u3 V3 d
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
; _) n; t+ C7 J% U7 i5 K1 d8 y四、调试: T+ G: i' D# X' |; P$ i6 P1 k
       单纯的开发代码片段的话测试和调试都非常简单:
( w1 t. H+ u" Y+ ~  r' \
  • 首先先自定义全局的code snippet。
      D( R  m& g- Z, W, G- K; Q# J1 v# q
4.jpg
, J) d  `5 M9 Y9 b
  • 选择新建全局代码片段文件。( H0 u  N& m9 @6 E9 O$ ^6 h
5.jpg 5 q& V, G$ v( h8 D7 `
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    $ e" L" x. q) i* F2 g
6.jpg - y: B8 K' X" u! `% Q" ]
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    # _0 g; F/ J4 r& X
7.jpg ( r; w( ]9 Y( i: W: l
       生成的代码片段如下:! }  H& |- v& t' q) B
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;
五、打包( c+ q1 [' F3 K, n
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。) K# V! \9 m" t) F# C1 t- O& I
六、发布
# z' m& u8 N4 }4 N: D       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
) y5 v+ Y, f* j% k' T8 Z7 i8 T  T# p 8.jpg 4 U; y$ e% g5 h1 V: S1 u
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
6 @. I) \3 d+ I 9.jpg ( s6 n8 _( m8 O7 S( p* J% U0 H
七、结语2 ]! B) K+ k. W& d( K2 Z
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-14 01:06

Powered by paopaomj X3.5 © 2016-2025 sitemap

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