QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4811|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言7 Y, G6 ~* O6 |/ i1 R
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。
( U2 T- ~0 s9 O/ T二、环境准备3 @1 s1 H$ P2 w/ {( t6 ^8 ]! s
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    7 G  z4 h  [2 t/ Y8 V7 Y4 M( Q0 [
三、开发者账号申请2 M+ w4 R+ v2 X. S" A" x5 [
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
0 `9 w# Y& f& s7 `1.注册并登录 Azure DevOps. h& P$ a: d' u7 R0 x+ n
2.选择或者创建一个组织(new organization)。
1 `$ ]0 v6 V+ O) x* v1 e; r3.在该组织下创建一个项目(new project)。- e2 R* Y1 s$ u6 ^
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:
3 n( D" _- l0 a5 t# u 1.jpg , o5 x& x8 Q  [4 Z
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
3 k' n$ u) C. o8 R# a4 b- {- I 2.jpg 1 y9 C! N4 |- g+ M) B! h
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。5 X* ^% K( R: \9 V
三、项目搭建: m% M& a9 D* L9 o
1、项目初始化( f9 Q% C; _) F1 G
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。) i8 S/ q2 ~6 [( e+ m& C) Q
3.jpg
2 i- D! e6 {/ ]0 S9 \* V' k- L2、项目改造
7 U2 E+ c; p  i1 y+ L0 z  _       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:  u& L* p7 i# Q1 D5 y$ N
1.将package.json改造成以下模样:. j% f0 h3 v: E2 J: ]- 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包会失败。% {4 X9 X! O  l
3、编码7 l) x8 `9 b  G7 o3 C5 j8 k. t5 D
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
9 \: ]2 m1 l) Q3 g1 r
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
, p  E/ w6 ^' k/ j四、调试
" G6 s. _' r7 D: R; r       单纯的开发代码片段的话测试和调试都非常简单:
' e/ i0 b1 \: i/ j" @6 s
  • 首先先自定义全局的code snippet。& ?4 m# @+ J2 @- v  R
4.jpg
9 W6 g) F. L9 Z+ r
  • 选择新建全局代码片段文件。) m% ~: H/ A: ~
5.jpg
7 r* V2 j, Y* u" G( s
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    1 _  w7 M2 L% K9 L* z: X2 i/ K" e0 v
6.jpg 0 J5 |: c  J; M
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。$ b& _' z- S& W' q8 t) l
7.jpg
( T% Z, V; ~1 ~/ p* n2 F       生成的代码片段如下:( D; K- C7 z  q- [2 _3 f
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;
五、打包
# K) n3 w8 Y  K- r; M       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。: m' R: J( ?, B
六、发布2 g" I4 I. t, X- U0 r
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
, P6 p" Z3 H( j  n 8.jpg
; C! Z" W" W0 P' T9 [  I: l) S       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~
& E: Y. r+ h% \3 N% x 9.jpg & ~# \5 V1 H  [$ Y2 e6 I. B6 @4 h
七、结语
* C& S7 G( `) ?3 i4 c7 V       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-6-18 18:12

Powered by paopaomj X3.5 © 2016-2025 sitemap

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