写了一个轻量级的自动构建部署vscode插件

2,756 阅读2分钟

目前已经发布在vscode的插件库中,搜索light-deploy即可

插件支持的vscode版本目前是1.44.0+,因为是基于微软最新的脚手架工具打的

效果图

目前支持的功能

  • 自动构建
  • 自动压缩(压缩方式tar.gz)
  • 自动上传服务器备份
  • 自动发布

操作步骤

  1. 配置setting.json
  2. 在左侧资源管理器选择开始的路径,右键选择执行发布(light-deploy)

配置说明

安装之后需要在setting.json里配置,也可以点击文件->首选项->设置->扩展->Light-deploy进行配置 目前支持的配置如下

"light-deploy.config": {
      //开启的配置(和name对应)
      "active": "dev",
      "configuration": [
         {
             //配置名称
            "name": "dev",
            //服务器连接配置(使用node-ssh)可以使用公私钥,详细配置可以参看node-ssh的配置
            "ssh": {
               "host": "172.16.5.33",
               "port": 22,
               "username": "root",
               "password": "root",
            },
            //是否自动构建
            "autoBuild": true,
            //构建配置
            "build":{
                //执行的命令,默认是npm run build
                "cmd":"npm run build",
                //默认是构建路径,如配置,优于构建路径
                "path":""
            },
            //是否自动压缩
            "autoCompress": true,
            //是否自动备份
            "autoBak": true,
            //本地配置
            "local": {
                //构建输出的文件夹,相对于构建路径
               "buildOutDir": "dist",
               //构建路径,可不填,默认是右键选择的地址,如果填了,优于右键选择地址
               "projectRootPath":"",
            },
            //远程配置
            "remote": {
                //备份路径
               "bakPath": "~/bak",
               //发布路径
               "releasePath": "/netty-socket/web",
            }
         }
      ]
   }

关于配置的几项说明

  • 构建路径:构建开始的路径,右键点击执行发布(light-deploy)时的路径,也可以在build选项中加入配置projectRootPath,此配置优于右键选择配置
  • 文件上传位置:目前默认是linux登录用户的个人文件夹,即~

即将实现

  • 支持配置日期格式化
  • 支持配置自动删除本地/远程构建文件
  • 支持全局配置
  • 支持配置压缩方式

写在最后

最近写了一个前端项目,苦于每次都要进行手动发布,苦其久矣,网上找了一些插件也不能满足自己的需要,前段时间看了一篇基于node的打包文章(打酱油12138),但是觉得还不够方便,便想能不能写vscode的插件来实现,遂去查了一下vscode插件的实现方式,发现vscode可以基于node通过js或者ts的方式来写插件,这不是就是让我操作的嘛,看了文档,写了一个比较简单的插件出来

第一次写vscode插件,也是第一次写基于node的项目,期间查了各种各样的文档,加上一个人开发,自己也是简单的测试了一下,可能会有些bug,不过提升工作效率还是可以的。

代码

可以配合sync setting等vscode配置同步插件来同步配置

核心代码

插件