QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4662|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言9 b  a+ q4 H9 H: F4 ?6 ]
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
- c2 e+ _, ~) C# E( W" n% p二、环境准备+ A: |5 \- Z, A' m/ D
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g! a  U# R1 k8 r6 Q; G4 g
三、开发者账号申请2 u/ M5 }9 M( B( h
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
1 C) h7 ^2 H1 D. q; F1.注册并登录 Azure DevOps
  C. ^: |* x" {# @  W+ F4 U7 g3 q2.选择或者创建一个组织(new organization)。4 z1 x& i1 a' @( G! ^5 v# x
3.在该组织下创建一个项目(new project)。
3 I2 o$ i7 B6 u1 z0 q       以上三步都是为了获取开发者(publisher)的token,获取token如下图:8 a1 o; F3 r  ~! ?* G
1.jpg
. o3 i, }# H; W+ d4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。( F! O; X* \! F  M5 v6 j! i
2.jpg
7 N- s4 m0 y8 f- R' Y5 {$ S5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
3 v9 y" {& T: z% V6 C三、项目搭建4 u( n6 u/ d# @+ e
1、项目初始化
+ m& N3 |3 ~1 ?7 f# N* j8 Q1 p
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    % r7 J& d; \/ L" U1 s9 V% U  V
3.jpg & v2 D7 U: s. e5 G, v
2、项目改造
0 |, r5 [; W4 A; {' d       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:7 b( P# e0 c# v; ?( M  n) {! u
1.将package.json改造成以下模样:, L- s3 y% }2 }" z0 n7 m
{
  "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包会失败。) ]' g2 c8 q8 F2 s$ c' c/ J8 u5 X8 K
3、编码1 X6 \' J1 i; A7 T) d
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:) c) N" P  S1 a: s
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
4 \6 S  |" Q! B0 h+ z& C/ ^' G  m. ~四、调试+ l% n6 h) a7 |6 N" \/ [
       单纯的开发代码片段的话测试和调试都非常简单:
, Y' c' b' }  i. c& Z
  • 首先先自定义全局的code snippet。
    4 R" N9 _$ n' v3 |3 S' q, y+ o
4.jpg
6 m( D: r$ V% l: c/ |$ U' j7 i
  • 选择新建全局代码片段文件。
    + f5 p5 v2 }: y5 [" E+ ]/ e8 y
5.jpg
  U5 w3 Z9 k# K
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    - q6 b. T- a  o: g/ j1 _( A! g% D
6.jpg
! k- e2 j2 B, S& P, g6 u
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。% \1 _. s( Y8 A0 y1 A2 l# G2 c
7.jpg - m* y5 J; h# U* S& ?/ Y5 X
       生成的代码片段如下:
+ N4 x9 B5 K6 ?8 I, c; k
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;
五、打包
+ m' |* \4 G* a* h0 \. u: c       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。8 v! i! D2 K9 {2 ?/ h" P
六、发布# y- B4 f0 w/ `) N( \1 t1 O  p
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
! {4 X9 E$ p9 w( t0 m 8.jpg
& U0 ]" i+ i% f7 M       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
, M$ ~3 I/ ]# q 9.jpg
7 {' @3 k4 H$ D! n! T; B' `七、结语& K( m- i. g8 T3 |
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-1 06:32

Powered by paopaomj X3.5 © 2016-2025 sitemap

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