QQ登录

只需要一步,快速开始

APP扫码登录

只需要一步,快速开始

查看: 4279|回复: 0

[其它] 快速打造 vscode 插件

[复制链接]

等级头衔

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

丰功伟绩

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

联系方式
发表于 2021-6-2 09:44:26 | 显示全部楼层 |阅读模式
一、前言' ]& M  K( ]1 }$ p# Z
       本文为vscode插件——code snippets开发的踩坑笔记,旨在提供一个快捷有效的方式打造一款自己的vscode插件。上手不难,但是就是坑比较多,为了避免更多人踩坑,于是写文避坑。本文针对新手,楼主也是花了半天时间上手去踩坑的。文末有github仓库地址,码友们可以直接clone下来当作以后code snippets插件的模板。" I# k* x4 t8 y
二、环境准备5 ]4 ?* [7 _, G  u3 M' u/ W
  • node
  • npm
  • yeoman sudo npm i yo -g
  • gernerator-code sudo npm i gernerator-code -g
    6 v6 E# L& B! ~. W9 I1 V3 Z  ^
三、开发者账号申请4 P4 v5 b, i" g2 `! R
       点击 Visual Studio Team Services,点击最上方立即注册,注册自己的账号,可以用GitHub账号直接登录。
, z( d, z9 I, H& U- E) Z1.注册并登录 Azure DevOps
6 V8 a( M' h% e2 a- n1 b2 e* r2.选择或者创建一个组织(new organization)。% w: U+ a8 T: @
3.在该组织下创建一个项目(new project)。
, d/ @& e8 U+ t' C7 t3 V, B2 @       以上三步都是为了获取开发者(publisher)的token,获取token如下图:' P4 n/ m- V5 e& O
1.jpg
/ k6 Q! d, ^+ H  X" s( \+ B  ~4. 点击 New Token,注意这里创建token一定要下拉选择 all accessible organizations,然后点击右下角的 Show all scopes 找到 Marketplace 选择 Manage。
$ S6 @/ ]5 @4 {: D 2.jpg ( I) X; ~+ `7 b% l
5. 注册vscode插件开发者(publisher):点击此处。注册保证name和id一致,并且只需要填写这两个就可以了。
) L! M8 a* E$ z- Q9 |三、项目搭建
' }, Q5 G7 Q; `1、项目初始化
6 ~# H% v) J3 R" q. w! B5 R+ _
  • 终端输入 yo code。
  • 选项如下设置:language选择javascript,名称就是你扩展的名称。
    9 `2 p3 X. u3 w2 m' v
3.jpg
0 T9 d- C( K; S2 _% }2、项目改造
/ a6 U$ M8 U. p       将项目文件夹yc-charts-code-snippets(你的扩展名字的文件夹)拖到vscode中打开。做以下改造:
" t* l, _7 a4 I) g$ [8 F- r1.将package.json改造成以下模样:0 q9 K9 _# R) z  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包会失败。' L2 m, G' }9 K" D
3、编码8 y+ q# p9 s3 D  v( h$ Y8 D- }( C
       这里的编码其实并不是写js,而是写json配置,在哪里写呢?在项目的 snippets 文件夹中的 snippets.code-snippets 文件中写入:
8 g+ G0 {; H  O9 ~0 f' ?& `
{
  "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 U' |9 f9 \5 C( _% F( S四、调试) F0 ^* ^- ]0 H: b, o
       单纯的开发代码片段的话测试和调试都非常简单:
5 x& F( \& C* I" b3 \
  • 首先先自定义全局的code snippet。( B" D% {" G/ F4 u6 H
4.jpg
( E1 i* a% i4 c# v) u* A& f
  • 选择新建全局代码片段文件。. n* q, _5 h: N# m5 p0 Q
5.jpg & X3 Y! {6 Y" h: y) L& G
  • 创建完文件名后会得到如下示例代码,放开example下面的代码即可测试。
    ; m. G7 R$ i5 F& L3 A9 p
6.jpg $ e$ ^( j8 `- Z+ y
  • command + shift + D 打开调试模式。
  • 点击 Extension 旁边的绿色三角形,打开扩展开发宿主。
  • 在扩展开发宿主中创建适合的文件类型如:test.js。
  • 测试自己的写的 prefix 即可。这里我生成的代码片段是自己封装的组件的示例代码。6 w0 x& {2 K. L0 G. R
7.jpg * J& P: N1 \' `1 m; _7 ~5 ?
       生成的代码片段如下:$ I# M! C8 ^6 \, ~6 D
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;
五、打包4 G/ s8 g0 Y5 w
       终端运行命令 vsce package 之后会生成一个打包好的二进制文件。$ [, k9 G! _. B
六、发布3 P  {  H9 N7 Y+ p$ ^. J
       终端运行命令 vsce publish,命令运行完之后需要等待几分钟,之后你注册账号的邮箱会收到一封发布成功的邮件,那么恭喜你成功发布了一款vscode插件!
7 ~& p! z) ]+ m/ ^# s, y) N1 i& {) Z 8.jpg
! V3 A6 ~7 M- e       点击上图标记的url可以看到自己插件的一个访问和下载情况的统计图,如果是404请耐心等待几分钟哦~6 k+ @2 Z2 Q7 P. K( f. y( U4 M
9.jpg
6 X6 `# `% v/ h# q/ S七、结语
% {! h+ s  }% E* ^       vscode的code snippets插件是最容易实现的一款插件,对于入门的同学来说是一个很好的上手例子。可以看到其实并没有什么编码工作,但是确实很多坑在里面。写这篇文章的目的就是让更少的人再去踩坑,希望对码友们有帮助~。本文项目github仓库:点击此处
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

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

GMT+8, 2026-2-8 06:48

Powered by paopaomj X3.5 © 2016-2025 sitemap

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