QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4300|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
" @  b4 T0 E- t9 h$ ]( a) Q4 i       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
# \$ e7 x0 l" t& {* q: N. [二、环境准备- N0 d" W) s- @) N7 A
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g: y4 I$ j7 w. C' v
三、开发者账号申请$ {+ [- H/ u9 r" K
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
2 [7 e* r% D0 w" c. @; S! {# U. n. o7 J1.注册并登录 Azure DevOps
8 m( H2 ?+ M/ |) H: z& c6 }2.选择或者创建一个组织(new organization)。
5 \. [8 @; @$ c3 m3 m. X" E3.在该组织下创建一个项目(new project)。
2 X% l/ F+ {0 u       以上三步都是为了获取开发者(publisher)的token,获取token如下图:* d6 ~4 q7 A+ n$ ^; M* r1 S
1.jpg : P( [8 o% Z) q4 g9 y* M
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
# m3 V2 m0 W7 k 2.jpg . a" d( G' r, I1 P& y
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
6 z2 ]1 _, w9 E; n$ z三、项目搭建' b( c  w- G4 T$ I  {
1、项目初始化
1 J/ c9 t: K; _0 r8 k  g- z
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。! i/ l5 g; R0 G' p" u
3.jpg 5 r' ?7 L  D: J" P4 l
2、项目改造; O  g- K9 C; c* u: L
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
$ o9 K# ^$ z- v/ R/ f+ Q/ s1.将package.json改造成以下模样:
8 H: l, t7 O5 B" C' X* v
{
  "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包会失败。
0 P6 w- r' x8 ?/ [/ J: a3、编码
' c' Q% j5 G( V5 P. o       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:; e& ~. \, N/ Q* `5 G1 Z
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。& E6 A4 f0 [' ?1 }1 L. E- j* ^
四、调试: B% }' O7 p% n# J
       单纯的开发代码片段的话测试和调试都非常简单:
& n+ d+ Z. a8 b$ _; y9 V+ W
  • 首先先自定义全局的code snippet。$ w4 \3 Z5 ^- ^4 D
4.jpg * C; t$ q# |0 _3 }  \0 w
  • 选择新建全局代码片段文件。
    $ V8 u# u8 ]% B2 Q" E
5.jpg
: V' d: H) ~9 J9 C6 y
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。, O/ d1 M! r" e: _( M
6.jpg   }0 u0 b/ G- B! i9 v! z# ~
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。; W; X1 s( \2 a
7.jpg
( f' b* e0 S" T/ o- u2 I8 w       生成的代码片段如下:$ W& H2 U% ]# @% H5 Z; 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;
五、打包; B+ x3 j5 K, |, V7 ]8 t$ |% R& l0 M
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。& o" E: f0 r9 b& d  x- i
六、发布, \8 k' g3 c3 s6 m" a
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!; v! R% W0 Y+ I+ x! }
8.jpg
, ?* K! r% Y$ c       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~1 c! u: f6 v& ~% c% }
9.jpg 6 ]. E+ @, p1 d% ?, Y0 O
七、结语8 O- O0 G! Q: }8 x+ T2 N0 \
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-2-13 02:48

Powered by paopaomj X3.5 © 2016-2025 sitemap

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