QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4571|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
  C% Q+ O( W6 T( U# k       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
+ g5 e/ e2 O) ^5 w二、环境准备
5 I- @3 `: ~7 C! M
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g0 C& o  H8 ~  L/ [+ B% ?/ U' C$ x
三、开发者账号申请0 r6 h! k( Q( d0 ?
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。; `" i' s6 w. Z8 N
1.注册并登录 Azure DevOps
8 }( O7 j3 x& b1 F6 m/ J4 G2.选择或者创建一个组织(new organization)。3 A5 @$ m: k9 M2 z
3.在该组织下创建一个项目(new project)。* |5 C. }* B2 u( u- _# i; |+ c
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
5 `% Y! j0 G& y8 o& Q. X 1.jpg 6 N1 c+ k, ~9 k. j' y
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
7 u( A% R7 d8 n  x% H3 N 2.jpg " R. @9 `8 Y9 w0 W6 P1 c% J
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
  x( o/ N  W0 H4 O8 [. R三、项目搭建! U! c' N5 x! a- M: G2 U# n
1、项目初始化3 N5 R0 b6 c( e
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。( }  ?7 H/ U9 L3 @
3.jpg
2 I$ x* ~8 H$ C9 [9 ?2、项目改造# K% z" o- A0 ]& S2 \3 ^; P' S
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:' z5 [! ~' _) A+ {; i
1.将package.json改造成以下模样:2 P0 D- k; @. m- ?. \0 k
{
  "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包会失败。
; z* V2 [' \& w0 r3、编码
2 U4 q4 W/ v" q7 V# U       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:8 Y% t2 F9 L2 Y& p" F: O+ _0 Q
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。: k: i. y5 ~, ~' q& A* p% O6 x
四、调试, q8 O6 U" J; H
       单纯的开发代码片段的话测试和调试都非常简单:- u$ x$ O( [' J" m* g2 ~  @: x
  • 首先先自定义全局的code snippet。
    % W, X# l* \9 p% [9 s
4.jpg 0 ?9 K% z4 O& j
  • 选择新建全局代码片段文件。( I9 S& P; |; G: c) y- I2 ^9 g
5.jpg
! q9 _( e5 |( U& d5 L, f/ \
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    0 v0 b* q& z  b% x. x
6.jpg ; H8 D, A, j8 E2 u7 w5 B
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    / C+ p2 O5 u- a* B; R
7.jpg
4 }( L/ T; C" I3 B* u8 |& {       生成的代码片段如下:
& @; O/ C2 b2 L: R0 O: 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;
五、打包( ~1 D" c! V7 Z
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。+ {# w2 V1 F' E0 G: s+ [
六、发布
8 H4 U9 T' r6 x       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!& L+ H8 d" X) h# b- B6 T, f
8.jpg ) k* o- K) m1 ]; h/ v
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~# J# W5 i! k$ j4 b8 b
9.jpg   b. r1 B# W/ ?0 {) a
七、结语2 }8 u% i) q3 q- h( z
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-5-9 09:00

Powered by paopaomj X3.5 © 2016-2025 sitemap

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