QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5412|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
0 u8 j4 |# O7 B       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。# P$ N( J9 O' b9 u/ \( w5 G1 _+ f' f
二、环境准备
& M& v- b8 I7 x" @7 s9 y
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    & T& R  k- v% B+ e8 k
三、开发者账号申请8 ]+ }; A+ v6 W& K, u( H0 w; H' [7 L3 e
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。. e) }6 A% t3 `( R
1.注册并登录 Azure DevOps。
1 @: P1 C! b, N- @( d6 w2.选择或者创建一个组织(new organization)。  i* i! ?; M8 D0 X7 d
3.在该组织下创建一个项目(new project)。. {: E0 z. ^$ A( N9 q
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
! C* a) y0 M- M& T' h 1.jpg ) i) @% ?7 Z( [+ y! _
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
: v* s% ~+ J( f; i* y! V 2.jpg
) Z- S/ f) r2 ^* N6 a$ i5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。6 s, M: c) o! Y; A! l, U! L
三、项目搭建
  Y& |) N, ]' y4 ^1、项目初始化
; u1 e! s$ {6 `. A
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    * [( @3 w5 K4 A9 O6 n
3.jpg
% }4 |- g- k- b; E3 Y7 l2、项目改造+ \; U( J) w/ [) ]
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:4 l5 q3 C, q! n: z
1.将package.json改造成以下模样:% Q# \. U# C# o( N$ a1 }
{
  "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包会失败。
4 l2 ?! ~- \( b5 P# K" @1 G* e( e) r3、编码/ z. S* T1 O% k( \; }. V) S
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:, ]! ^' |- j* U( P9 U
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。/ C* L: g0 j* w/ z: [
四、调试$ ?$ t1 B" m; N6 G" d
       单纯的开发代码片段的话测试和调试都非常简单:* _4 v5 ^4 ?+ W' J
  • 首先先自定义全局的code snippet。. z0 w% C2 I' T( i
4.jpg 9 p1 p4 h: B( L3 z9 @) _; s
  • 选择新建全局代码片段文件。% z. ~8 p' t% X* [
5.jpg 9 d  W. [3 I" P1 h* {# |1 B! v
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    2 ~. [9 y3 g- p& V; l6 k$ I; y& g
6.jpg
) @/ z. C9 G9 k* w8 n4 ]* ]& _: y4 U
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    ' D1 `7 q* w5 m0 @9 @# n
7.jpg + u) e5 S( v& E7 Q3 ?' J
       生成的代码片段如下:
, C6 ]7 J" g9 Q3 N( n
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;
五、打包( j+ [* P4 z* C% }# e: S
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
; s4 H. _# T" O$ z4 F- P: j六、发布
; n$ k8 V6 [6 X4 e  Q4 z       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!7 B$ F- B2 [: |2 I
8.jpg 7 m* T# X. j) P7 ?
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~) c: H9 U9 A2 p
9.jpg 7 B" Q$ |8 w  _( S& |8 m$ p
七、结语
, C, E1 Q  m3 `* `% `       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处。
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-10-11 11:12

Powered by paopaomj X3.5 © 2016-2025 sitemap

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