QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4677|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言
! D. E7 Q6 ?- |7 `# P- @       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
+ }4 t; _$ f7 _* \( l二、环境准备7 Q) X& \# H! Z3 j: E
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g" s0 z. c6 q. t5 L. p  }1 y
三、开发者账号申请$ @. D5 T0 S6 X) b
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。- d* n/ G: [/ q! M" w
1.注册并登录 Azure DevOps; y! @+ }6 l5 `, v9 Z
2.选择或者创建一个组织(new organization)。
- \0 g" x* ]( u- N3.在该组织下创建一个项目(new project)。
6 }( V; Y- G( ]. ?6 @" G0 J9 j       以上三步都是为了获取开发者(publisher)的token,获取token如下图:! W( L1 j: O; T2 k4 u
1.jpg
, O) D# a- e! D9 G7 b4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
/ z# P- y( p! c" |! y. L% x 2.jpg 1 k6 D+ u# S/ T7 l
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。# q# Q( }+ Q+ Z3 `: v* L+ x
三、项目搭建" H9 y3 a# [4 P' c8 P
1、项目初始化
6 E4 ^# _& b7 ~7 |
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。3 G+ ~2 C. T9 ?6 C8 A7 n4 Y
3.jpg
1 R0 X# @, Q7 P* r" Z" |# l2、项目改造
0 ~, s1 a  r1 f/ a       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
5 y" W4 ~6 d# X. y4 E$ _1.将package.json改造成以下模样:4 ^' [, ~/ M. e  C" ~; g/ S- 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包会失败。
* }6 ^0 v6 }3 R" y3、编码! p* s( H7 K( \) z$ v
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:% F) H9 O, N) p1 }" \
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。( W1 F. ^6 |+ O2 |& {
四、调试
! p( ]( {2 k; R( Y# A, ~       单纯的开发代码片段的话测试和调试都非常简单:# r4 N' s6 i0 m! Q! b9 X! u: D
  • 首先先自定义全局的code snippet。
    7 Y. L3 K( U5 V
4.jpg
( n! H+ o) V) g3 e0 l! h1 N
  • 选择新建全局代码片段文件。2 Y3 B- Z9 }8 g1 X3 L' i' T/ f
5.jpg ( W$ F, B6 y' I0 {( `
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    & P% l2 o! S$ r
6.jpg 9 Y/ N# s( m- L3 S* ^9 x3 ]
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。4 Z3 ~# a! K- V& `2 I) L
7.jpg
  z0 {; N( C( K& J# F. M  c% t       生成的代码片段如下:8 E) w, K: j2 T3 p$ `9 E
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;
五、打包+ V3 T6 C0 v4 |* V, o0 l
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。8 l: M- R4 y% l. z9 a* `
六、发布
: ?$ M2 r' g! p9 K# U0 O) z       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!  `- H- s* U+ c( R
8.jpg
  M9 u3 e: V3 [6 p3 N/ S( @       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
9 n5 B4 Z) P& R6 E 9.jpg
# U5 Q: g" K% h6 N# L# x七、结语6 t+ C" a4 q- V1 D' e
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-3 13:31

Powered by paopaomj X3.5 © 2016-2025 sitemap

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