QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5245|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
8 d1 H4 M% D# Z, i       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。7 R( r$ n) E1 R! M1 _  {
二、环境准备
7 Q$ G6 `6 M8 }# j* q8 m. O
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    1 _/ q$ z) L& A- {: B
三、开发者账号申请2 m8 F+ S& J5 {: [
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。( K* \* F/ z) i" _+ S' Y, h
1.注册并登录 Azure DevOps( R' ~" s+ [1 k2 \8 g
2.选择或者创建一个组织(new organization)。
& e1 I0 [5 s+ w; M8 G' Y3.在该组织下创建一个项目(new project)。4 j$ W$ C' |; ]2 ^1 e# l* E
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
; L5 v$ `- y; J2 m* ?4 s 1.jpg " \, e  _) a% P1 C$ Q* G/ B4 z
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。. T3 S$ H: z+ n# V
2.jpg : G! [" i: }: `& ?) t7 d  ?# l" S0 V
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
+ K' B3 j; y5 q/ G* z, D) {2 K三、项目搭建1 r; @  H9 p& `' o* R& w
1、项目初始化% ]: e; t" x9 ~# K
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    ' w2 ]7 O: k7 c
3.jpg # _+ M; J4 v1 C" ?* A: b8 F% Y
2、项目改造- t1 O3 u# Z, ]! l+ }
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:( J" _0 z( w; d' N" p: y4 [
1.将package.json改造成以下模样:
1 v) O- X/ c* T$ H7 q2 j9 U
{
  "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包会失败。& H! J4 h# d# Q4 b
3、编码7 z, y1 x2 a* q. |$ ?3 O
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:" U) B4 A" L0 U: v+ P
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。" E8 s1 K4 N; c: Z$ W$ G
四、调试) f. {0 m, V5 P0 U' D
       单纯的开发代码片段的话测试和调试都非常简单:/ x( G4 r: c) q6 L
  • 首先先自定义全局的code snippet。
    ! z, d  H& ~$ |9 O3 U5 j( \6 f( O
4.jpg 0 `/ _5 I6 A: V; A  K
  • 选择新建全局代码片段文件。9 T: M( {" z& h. \) N2 }
5.jpg
. Y8 a; I) B& a  r' |
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    6 q; f; L$ S) v$ h7 r* T* p
6.jpg
% E& t8 _4 o- J8 W% d. B
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。1 d# ]3 l& Y1 V8 N. i- d
7.jpg & K% J+ T2 E" ?8 U- p9 M
       生成的代码片段如下:% l4 r; m1 c' Q9 D2 x6 k+ y$ _4 V
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;
五、打包! w6 l( I) C5 X
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。& Y5 b8 M) @1 K% ?) {
六、发布
8 `" i. W  r/ \  s2 ~5 l       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!3 B% v$ X7 R1 K6 B
8.jpg 2 A9 Q0 v/ j: \4 _# s  w3 n
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
; w% w2 D* ]! r2 X 9.jpg
* G' [6 b- L) V, X5 d. @七、结语
" f2 v* `/ j; `/ n1 n       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-8-8 04:33

Powered by paopaomj X3.5 © 2016-2025 sitemap

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