QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5136|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
) ~5 Y0 e6 P2 X9 `7 S% ?9 T       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。4 w1 O8 y: h) y3 ~* m
二、环境准备1 h0 o" \- ~( d8 {+ B! A. ?
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g. m! z7 U- R" i5 n) N" L/ w) I
三、开发者账号申请( b0 i! `, h; {9 c
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
$ @, P4 D( H8 N: R+ k1.注册并登录 Azure DevOps$ Y0 L; M3 J( {
2.选择或者创建一个组织(new organization)。2 p4 L! ?$ y& X# l( ]  v" @) v+ P  l- g
3.在该组织下创建一个项目(new project)。
) d4 k, j: a" @1 I3 K- S       以上三步都是为了获取开发者(publisher)的token,获取token如下图:5 b7 g# y$ y. O, j
1.jpg
. n( M1 ^4 c5 @9 n, j4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。: G5 ~! ~1 d4 o% b& h
2.jpg
' A0 m# @9 C6 `) _. ?7 v6 A8 [  B& q5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。( P+ E$ M! u$ f( r$ v7 r
三、项目搭建
. n+ v# X7 q+ I+ V1、项目初始化+ n, G9 B/ }% a- x
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。" O# H3 O/ C8 v* U. u; ?. L& g; D
3.jpg
7 i2 h1 D$ J' C2 E; {% F7 q$ a* p: k9 d2、项目改造
- F# h1 i0 e- c7 U2 m# s( H  w# O       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:2 ^. k6 O  ]# e& r' ~# J9 w" K8 H
1.将package.json改造成以下模样:. e8 ^/ y& i% q$ h: A6 _2 v9 h
{
  "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包会失败。
7 i; ]" o2 B* `) @- c$ }3、编码0 ^! q, ]% t/ j/ w2 M! h
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:) l2 i, h5 _7 {% }4 O) A" 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。8 z2 q  q: b2 F
四、调试" n7 G' B9 O( X2 \$ P1 O
       单纯的开发代码片段的话测试和调试都非常简单:3 o% T6 T' Z: |: X. [
  • 首先先自定义全局的code snippet。
    6 x  K4 x$ \8 Q4 ]
4.jpg 4 \/ ]6 @4 i" [8 ^, @  l" A0 e
  • 选择新建全局代码片段文件。
    / w# [# C  l+ u' f
5.jpg - A- b* N8 F1 B$ d. n% [1 C  {
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。) F- V. c7 o& w, V7 Z% U  ^
6.jpg ) j/ A7 F5 _/ @- N1 s+ x$ R
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。! _5 h2 Z, F" A3 j5 s
7.jpg # y1 o. A8 L" {, z3 h4 @
       生成的代码片段如下:
: ~1 I8 ~: @- [2 D$ C# h, ?$ h
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;
五、打包
, l- s; C1 u  A; }       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。  i7 E! V4 j# r0 m0 ^- m$ k8 {% X
六、发布
9 I2 F1 g* H" S) [6 ?0 ]. E       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!  U' S; U0 D" }5 c: ~
8.jpg ; R/ ~6 W- y, S" T4 L
       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~" X( w9 y+ x9 w4 H! T4 `6 `
9.jpg
2 }3 l. d' a: \8 w8 i% l/ [* L七、结语1 f# ?, [8 m0 Y
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-23 04:51

Powered by paopaomj X3.5 © 2016-2025 sitemap

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