在前端开发中,我们通常需要将我们编写的代码发布到生产环境中,这个过程需要花费很多时间和精力。但是,通过使用 npm 包 @sourecode/deploy-cli,我们可以大大简化代码发布过程,节省时间和精力。本篇文章将会详细介绍如何使用 @sourecode/deploy-cli 进行代码发布,包括安装、配置以及使用。
一、@sourecode/deploy-cli 包是什么?
@sourecode/deploy-cli 是一个用于自动化部署前端代码到生产环境的 npm 包。它提供了一个简单的命令行界面,可以快速、安全地发布项目。该包包含以下功能:
- 自动化部署前端代码到生产环境
- 支持多种协议(如 FTP、SFTP、SCP 等)
- 支持多种服务器类型(如 Linux、Unix、Windows 等)
- 自动备份已有代码,以便出现问题时可以恢复
- 支持互动命令行,提供更加友好的用户体验
二、安装 @sourecode/deploy-cli
要使用 @sourecode/deploy-cli 包,我们首先需要安装它。使用以下命令即可:
--- ------- -- ---------------------
三、配置
成功安装 @sourecode/deploy-cli 后,我们需要配置我们的项目信息。在项目根目录中,创建一个 deploy.config.js 文件。在该文件中配置以下信息:
-------------- - - -- --------- ------- - ----- --- -- ----- ----- --- -- ----- --------- --- -- --------- --------- --- -- -------- ----- --- -- ---------- -- -- ----------------------- ------- - ------- ------ -- ------ ------- ------- -- --------- ----- --- -- ------- -- -- ------- ------- - --------------- --- -- ---------- -------------- --- -- ---------- ----------- --- -- --------------- ----------- --- -- ----------- - -
其中,我们需要填写的信息包括:
- server:我们要部署到的服务器信息。
- host:需要部署到的服务器地址。
- port:服务器端口号,一般情况下使用默认端口号即可,若服务器使用非默认端口号,则需要填写对应的端口号。
- username:登录服务器的用户名。
- password:登录服务器的密码。
- path:服务器存放代码的路径。
- backup:备份相关的配置项。
- enable:是否开启备份功能。如果开启,则部署前会备份服务器上存放的代码文件,以便出现问题时可以快速恢复。
- prefix:备份文件的前缀名称。备份文件的名称格式为
{prefix}_{时间戳}_{版本号}
,例如.bak_1619691323225_v1
。 - path:备份文件存放的路径。
- deploy:部署相关的配置项。
- commandsBefore:在部署前需要执行的命令列表。
- commandsAfter:在部署后需要执行的命令列表。
- sourcePath:本地待上传的文件或文件夹的路径。
- targetPath:服务器上存放代码的路径。
四、使用
成功配置好 deploy.config.js 后,我们就可以使用 @sourecode/deploy-cli 进行部署了。运行以下命令即可:
------ ---------
其中,可选项包括:
- -V, --version:输出版本号。
- -h, --help:输出帮助信息。
- --setup-ssh:一键配置 ssh,生成 ssh key 并上传到目标服务器。仅支持 Linux 和 Mac 系统。
五、示例代码
为了更好地理解 @sourecode/deploy-cli 的使用方法,我们来看一个示例,假设我们的项目需要部署到服务器 192.168.1.100 的路径 /var/www/html/my-app 下。
首先,在项目的根目录中创建一个 deploy.config.js 文件,并配置以下信息:
-------------- - - ------- - ----- ---------------- ----- --- --------- ------- --------- -------------- ----- ----------------------- -- ------- - ------- ----- ------- ------- ----- ------------------------ -- ------- - --------------- --- -------------- --- ----------- --------- ----------- ----------------------- - -
然后,在终端中运行以下命令:
------
等待部署完成后,我们就可以在浏览器中访问 http://192.168.1.100/my-app 来查看部署结果了。
六、总结
通过本文,我们了解了如何使用 npm 包 @sourecode/deploy-cli 自动化部署前端代码到生产环境。通过配置 deploy.config.js 文件,我们可以轻松部署我们的项目,并节省时间和精力。希望本文能够帮助到大家,提升前端开发效率。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600671a730d0927023822657