npm 包 @mcshovel/gsdk-deploy 使用教程

阅读时长 4 分钟读完

介绍

@mcshovel/gsdk-deploy 是一个基于 Node.js 的 npm 包,用来发布 Gulp Starter Kit (GSK) 构建的前端项目。它提供了一套命令行工具来帮助我们发布代码到远程服务器,自动打包前端静态资源,并执行一些自定义脚本。

在接下来的文章中,我们将学习如何使用 @mcshovel/gsdk-deploy 包来构建和发布我们的前端项目。

安装

我们可以使用 npm 来安装 @mcshovel/gsdk-deploy 包。需要先在本地全局安装 gulp 和 gulp-cli:

然后再安装 @mcshovel/gsdk-deploy:

配置

在使用 @mcshovel/gsdk-deploy 之前,我们需要对配置文件进行一些修改。这个文件位于项目根目录下的 deploy.config.js,该文件包含了我们的项目配置信息,如下所示:

-- -------------------- ---- -------
-------------- - -
    -- ----------
    ----- --------------
    -- -----------
    --------- ---------------
    -- ----------
    --------- ---------------
    -- ----------------
    ---------- -------
    -- -----------------
    ----------- ----------------
    -- ----------
    ------------- -----------------------------
    -- ----------
    ------------ ---------------------------
-

在该文件中,我们需要配置以下参数:

  • host: 目标服务器地址
  • username: 目标服务器登录用户名
  • password: 目标服务器登录密码
  • localPath: 本地需要部署的文件所在目录
  • remotePath: 目标服务器远程部署路径
  • beforeDeploy: 部署前需要运行的自定义脚本路径
  • afterDeploy: 部署后需要运行的自定义脚本路径

其中,beforeDeployafterDeploy 是可选字段,如果我们没有需要运行的脚本,则可以忽略这个参数。

使用

在我们配置好 deploy.config.js 文件之后,我们可以使用下面的命令来部署我们的项目:

执行该命令后,@mcshovel/gsdk-deploy 将会自动运行 gulp 编译命令,打包我们的项目并将打包后的文件上传到目标服务器的远程目录。同时会运行我们配置的 beforeDeployafterDeploy 脚本。

示例代码

下面是一个完整的 deploy.config.js 文件的示例代码:

-- -------------------- ---- -------
-------------- - -
    -- ----------
    ----- --------------
    -- -----------
    --------- ---------------
    -- ----------
    --------- ---------------
    -- ----------------
    ---------- -------
    -- -----------------
    ----------- ----------------
    -- ----------
    ------------- -----------------------------
    -- ----------
    ------------ ---------------------------
-

我们可以将其复制到项目根目录下,并根据实际情况进行配置即可。

总结

本文介绍了如何使用 @mcshovel/gsdk-deploy 包来部署前端项目。只需要通过简单配置就可以实现自动打包和部署,大大提高了前端开发效率。在实际使用过程中,我们也可以根据自己的需求来编写自定义部署脚本,以达到更高的灵活性和便利性。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055d0881e8991b448da9cf

纠错
反馈