QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 5031|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言% X' L/ n- K- A' @8 B) U# z6 h
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。0 i. t( A* b0 h
二、环境准备
  A. n+ b; y8 G2 r; o
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    6 i; n1 I6 {. y/ Q2 g
三、开发者账号申请: [7 E+ ?, @' ~3 `
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。7 N( Q. R- T  c: j3 e
1.注册并登录 Azure DevOps5 k, b- e8 C7 |  k: C5 k
2.选择或者创建一个组织(new organization)。0 d5 v# u$ m* x" I9 t
3.在该组织下创建一个项目(new project)。
" V: y. h2 i* E4 I6 r, E( H       以上三步都是为了获取开发者(publisher)的token,获取token如下图:- t" a  N& u: d* {# a
1.jpg * u/ U, a+ m  d3 ~( Y7 d, ?7 y$ c
4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。* b) o  U2 {+ H# k, A
2.jpg
1 Z8 n8 w+ y" [5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。; Q2 t+ Q  d% W" r
三、项目搭建
+ v# P( W6 e' u: h1 F1 \1、项目初始化
' w$ K; J( j3 j. e7 a5 |; k8 F
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    & H8 A! x" Y& A7 X1 y5 T8 O3 x7 m. T
3.jpg : o0 v/ j+ g6 A4 u2 j
2、项目改造! y$ `$ Y, Q* ]0 x( K' J& I5 C
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
3 a. b/ Q, l* c6 C; }  G2 E1.将package.json改造成以下模样:2 f. _% b: H, o* Y4 i. |
{
  "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 e. Z& Y& O4 D, G' ?
3、编码2 Y, Y/ }* R, ~% E- |' e/ b9 }2 I
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:! R; s2 M5 m# n9 }8 J; ]
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。  y& p' N4 W  V6 M" ]
四、调试
6 F  }( X  p9 Y7 l" M' e' h       单纯的开发代码片段的话测试和调试都非常简单:3 Y" |. N  S) L# U! Q% _
  • 首先先自定义全局的code snippet。
    / p" W  T6 b+ n9 C2 c2 L0 X" V
4.jpg 6 f  C7 D3 ?, E' @/ q
  • 选择新建全局代码片段文件。
    & C+ Z& [' G" D) w& i8 D
5.jpg
8 c& l, c- `" v& K
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。" Y% K/ o  r  D4 \; B. r
6.jpg ' z5 F' m( e* b' f6 z
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。: i$ A  c- `0 @6 U3 a1 P
7.jpg 6 ~6 v, J( {) ~) G# c2 I7 T
       生成的代码片段如下:, @1 r$ H! }9 Q0 I5 v7 I- }' `  G
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;
五、打包; N: S* }% {. h3 N/ K
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。# i, ]* n' W: \, E9 z# b( ^
六、发布( C* a" a- w0 V' C* c
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
$ X( ?- Z  i# u0 f3 ]' t9 A' L7 F" L 8.jpg
# A" y8 i& i/ w: p: M/ y" o       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~9 `. i; F7 V$ z/ v3 R1 K
9.jpg ) K; V* x; ~8 ?% H0 W2 |) k
七、结语& m( f7 Y5 \7 w6 Z! _
       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-7-9 10:20

Powered by paopaomj X3.5 © 2016-2025 sitemap

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