QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

手机号码,快捷登录

手机号码,快捷登录

查看: 2043|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

积分成就    金币 : 2857
   泡泡 : 1516
   精华 : 6
   在线时间 : 1316 小时
   最后登录 : 2025-2-16

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言+ v8 f5 \3 d! V* X$ ~4 Q! X/ N! d' e
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。* j! E$ D7 |/ X, h1 [5 Y. b5 j
二、环境准备
; N* U1 S7 ~- Z7 o
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g! V& E$ Z4 U. Y- u
三、开发者账号申请
& N7 M9 d, C- |; M! G4 `       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
8 E5 J4 l3 O4 s& g! F1.注册并登录 Azure DevOps
0 [& Z1 d: D4 m+ |* X' H2.选择或者创建一个组织(new organization)。& }# E8 L; Y4 c( ^
3.在该组织下创建一个项目(new project)。; H0 e! I0 _: x# @5 Z, t4 o
       以上三步都是为了获取开发者(publisher)的token,获取token如下图:: j- ^+ t+ ?0 i
1.jpg
$ W* b" K7 l1 z6 k* G4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
& ?) W3 ?3 E+ P3 M 2.jpg # I1 w3 W3 k! i- \
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
- x# N4 j, ~; q6 H# y三、项目搭建. r7 q9 P8 i6 o* U" C
1、项目初始化7 @7 i) z: |* v, i! g3 h# N
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    6 Y3 |* l/ Z7 N, P! g+ E9 e$ n
3.jpg 0 V! g2 N  c2 H1 @4 _( q  I
2、项目改造. Q+ N( w  k3 j' {9 c
       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:% R( ]  t) g& B% A1 T! S
1.将package.json改造成以下模样:
4 R; n9 Z. V# X- D. 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包会失败。
+ K% \* y) J& `9 v/ u# i3、编码  ?/ [3 X* j1 ~! }
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
/ }! i: g$ Z( G: ^" {
{
  "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键会跳转的语句,数字代表跳转的顺序,注意:冒号后面没有空格。
  B: @( h7 M$ C" V2 U9 x四、调试
" v% b( X& {( S) y  ]- c: X/ I       单纯的开发代码片段的话测试和调试都非常简单:
  H& _0 _) J" d- o
  • 首先先自定义全局的code snippet。
    , i# n3 J0 @: r' x4 d! |, B
4.jpg ) ?$ Y9 H0 E7 `6 ^9 m# m
  • 选择新建全局代码片段文件。4 C# b- j+ [6 N8 F$ ~( S$ S
5.jpg + Z1 v/ s2 ?* f. t
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。1 D5 u6 ^) d: T
6.jpg / }# }$ u8 A1 W9 v% l
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。) D, v6 O& j' x( [4 n* Z. T
7.jpg ( j+ u+ Y. {$ [
       生成的代码片段如下:
4 n: @( g3 L! z4 Z
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# \3 W  P6 d       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。) P1 A" v; V0 g1 }/ r9 T9 g
六、发布& {( ]# u- ]+ Q9 k. _% n$ g
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
$ g% _! i0 g0 q# R8 Y( O# K 8.jpg
4 Z, {3 |4 g* m% L       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~) R* R# B5 r$ a9 M6 O1 ], C
9.jpg
& E& y( c. w) g9 P6 a  |1 e七、结语
# N$ \% d( F, x  _6 p       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2025-2-19 06:51

Powered by paopaomj X3.5 © 2016-2025 sitemap

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