QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4962|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言+ \7 y  B: k" m9 y, r
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
$ S" z& T1 k3 d+ t7 h1 }$ _' b) z二、环境准备% `( x3 a2 U7 C+ R) T: k* B
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g0 R6 u( D" p1 n9 F1 C! p$ T0 _
三、开发者账号申请% g1 z+ K( z! l9 b
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
, z; c1 P% W$ ?$ X! ^8 d; p1 ?1.注册并登录 Azure DevOps* c" \1 N- `) `! z- _% D$ c
2.选择或者创建一个组织(new organization)。8 K* I/ l" t" R
3.在该组织下创建一个项目(new project)。* X2 L" I# {4 w, Y& m! `
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:5 m' t+ d9 Q6 u) M9 Z% k
1.jpg * g% W/ i, P7 w7 y
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
" ]. D% y% \! X9 n9 \  a8 s 2.jpg
5 B( |$ x9 x# A4 q& s8 H5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。( b4 P/ F+ Q& B  [7 I! Y
三、项目搭建
' ?, Z& W. T. U1、项目初始化
3 i) x+ A) |, o& ~4 F4 d: g# v: H
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。0 M$ M/ y0 n: v* O: w  R1 k  U# D
3.jpg 9 o% ?" T) ?% U/ I2 F; ^& b
2、项目改造
1 R) h: X4 ^8 W       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
; u( B) Z$ z* K1 \% V/ P' b" ?1.将package.json改造成以下模样:0 k, `/ s" ]! A% e( ?$ H& m6 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包会失败。
8 X) y5 A( Y8 _+ x; ~2 E, i3、编码
9 K, n4 W6 ]9 w) @0 \9 X3 T4 b       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:& s) L) x# q% S. g0 J7 ]$ l( n4 o) J3 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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
% G6 D, f  ~2 j四、调试2 h3 R- l2 B+ t# m0 q* j; ^
       单纯的开发代码片段的话测试和调试都非常简单:
1 t1 U" y- E7 k9 ^7 {
  • 首先先自定义全局的code snippet。
    / V; ?" D! L* r# W  X- S8 K; p/ K
4.jpg
% \$ x' s0 z( k' w, D
  • 选择新建全局代码片段文件。
    + A/ F( }2 s% A* A4 ^2 _# P
5.jpg
9 F. f$ \* ?* h8 Y7 x3 K* }' W) O8 D" u
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。3 v" g: |% Z* F1 M$ }4 q7 l* r
6.jpg
" Z: ?+ _8 D! L) u# p# O+ i
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。
    1 Q3 h+ g! j1 A% A
7.jpg 9 M1 g/ U3 u4 d: ]
       生成的代码片段如下:) h; b$ z: P4 {$ h8 f8 ^- f: C
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;
五、打包" G, H8 v3 N3 A. e- R2 K
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。% x0 I1 ~  @+ Q4 \5 i, f
六、发布
4 l' Z9 @3 f9 d# M$ g3 q# G- K       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
* r" P/ Y/ [) {! Q( T( z* } 8.jpg
! s, b% |; ]1 w. P1 I       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~' q5 y; ~2 m0 }7 ^
9.jpg , F: e9 E/ _; Z0 S( R* v8 W
七、结语
# S8 v* ~1 Q7 e6 E. I  z       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-3 10:09

Powered by paopaomj X3.5 © 2016-2025 sitemap

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