npm 包 deployer-cli 使用教程

阅读时长 5 分钟读完

介绍

deployer-cli 是一个可以帮助前端开发者自动化部署代码的 npm 包。它可以将本地代码部署到生产环境,并提供了丰富的配置选项,使用户可以轻松地自定义部署流程。

安装

使用 npm 进行安装:

使用方法

在项目根目录下创建一个 deploy.js 文件,该文件为项目的部署配置文件。在该文件中,我们需要导出一个 deploy 函数,该函数会被 deployer-cli 调用。

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

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

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

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

在 deploy.js 中,我们通过传入一个参数对象,可以获得 env、 logger 和 ssh 三个对象。

  • env: 当前环境,值为 dev、test 或 prod。
  • logger: 日志对象,用于输出日志信息。
  • ssh: ssh 连接对象,用于连接远程服务器。

运行命令

运行以下命令,即可将项目部署到指定环境:

配置

deployer-cli 支持以下配置项:

配置项 类型 说明 默认值
host string 服务器地址 -
port number ssh 端口号 22
username string ssh 用户名 -
password string ssh 密码 -
privateKey string ssh 私钥文件路径 -
passphrase string ssh 私钥密码 -
deployDir string 服务器部署目录 /opt
appName string 应用名称,用于标识当前应用 -
backup Object 是否开启备份 false

其中,backup 支持以下配置项:

配置项 类型 说明 默认值
enable boolean 是否启用备份 false
keep number 保留备份数量 5

例如:

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

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

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

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

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

示例

以下示例是一个简单的 deploy.js 文件:

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

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

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

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

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

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

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

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

结论

通过 deployer-cli,我们可以轻松地将前端应用部署到生产环境,实现自动化部署,提高开发效率。同时,该工具还提供了丰富的配置选项,使用户可以灵活地自定义部署流程,满足个性化需求。

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

纠错
反馈