QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4173|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
' G! k- P/ S- y       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。& P4 N: y! y( V
二、环境准备/ W& j- Z; v9 P. |  v3 C$ b
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    * P2 \1 B: B: e* C" S
三、开发者账号申请  E- r7 l* ?% F$ w9 f' v# w' v' b
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。! N2 D" _7 n/ {5 T- W
1.注册并登录 Azure DevOps
+ y% t% N( ?) t2.选择或者创建一个组织(new organization)。
  G$ R5 }' O: [, K# i  y3.在该组织下创建一个项目(new project)。
+ O" b3 ~! G/ L! w       以上三步都是为了获取开发者(publisher)的token,获取token如下图:+ J' E( _2 k1 [8 o+ ^4 X
1.jpg & ?; U9 w5 o* R6 e
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
; V3 R( E' D# q4 C; }8 G 2.jpg
* @& O; e' {* s7 |! b+ Q  G5 L5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。" [1 n2 D; ]! }% t' N9 f; H- g4 z6 S! j
三、项目搭建
" ~+ T, i- Y  `$ Q: q, ]: v1、项目初始化- D" x/ U8 Y. n; f
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。$ A3 c6 z% L8 d) O# M$ R* C
3.jpg
1 x- E7 M7 W8 J& w. m2、项目改造( T- g* w' u% c/ X9 R" m9 P- A9 C
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
* D$ T. t2 \2 L; R( Y& w2 _1.将package.json改造成以下模样:& _: C1 l4 ~- k. M! A  G7 I+ X
{
  "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包会失败。) f/ p- b2 t- Y0 c+ R* T# w
3、编码
) z, r: r) g# f9 b       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:. C4 a8 [( K3 {1 r/ a1 E
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。, q& L+ D+ M6 H' q
四、调试+ a( y( K5 v" Z
       单纯的开发代码片段的话测试和调试都非常简单:
- E- j" ]3 {$ @, P7 r, T
  • 首先先自定义全局的code snippet。
    : K1 L' {: H$ k: e" m
4.jpg
6 U5 ?7 E! O  g6 j
  • 选择新建全局代码片段文件。
    % X  H# E  h4 a2 p# x: A; I1 j
5.jpg
; w7 b. y: u1 P& i: q5 Y4 M
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。$ |% J7 L. x  i, K
6.jpg ; K  M4 [: Y5 y9 Z" {6 r% z
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。. T8 @; Z1 j( U0 d" Y/ K7 D( ~. A* A
7.jpg * e1 n( j; M! }3 A) ^+ M$ ?# P
       生成的代码片段如下:
7 ~* L- T" E$ y# I
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;
五、打包
( q2 a! ?" x, O$ q1 r3 [9 R; Y       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。
3 n1 F$ d! I7 w+ y) A4 J  r4 \2 v3 F六、发布6 X) L! J8 B9 V+ `0 [
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
/ D% Q5 _" f$ X% f 8.jpg 8 o# z' O0 }  s3 o
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
% L1 U! Z, z+ E5 W" @3 [! h 9.jpg 6 z  i1 m; z* Y/ z+ ]% U
七、结语8 z% |& Y5 I- A- S" D4 L
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-1-13 15:33

Powered by paopaomj X3.5 © 2016-2025 sitemap

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