npm包@everreal/automation-scripts使用教程

阅读时长 5 分钟读完

介绍

npm包@everreal/automation-scripts提供了一种简单而又强大的方法来自动化前端开发中的常见任务,例如构建项目、运行测试、部署等等。它基于npm_scripts功能构建,允许你使用一行命令来执行多个任务。

安装

使用npm直接安装:

配置

在项目根目录下创建一个package.json文件。这里提供两种配置方式。

方式一

可以将以下字段添加到package.json的根目录:

方式二

package.json中的scripts字段改为如下结构:

-- -------------------- ---- -------
-
  ---------- -
    -------- ---- -------
    -------- ---- -------
    ------- ---- ------
    --------- ---- -------
  --
  ------------------------------- -
    --------- -
      -------- -
        ------------- ------
      -
    -
  -
-
展开代码

使用

通过在终端运行npm start,开始构建项目。

通过在终端运行npm run build,进行项目打包。

通过在终端运行npm test,开启项目测试。

通过在终端运行npm run deploy,来部署项目。

配置指南

ers start

启动开发模式,支持以下配置项:

  • port:为服务器指定端口。默认值:8080
  • open:是否自动打开浏览器。默认值:false
  • proxy:服务器代理配置。默认值:null

ers build

构建项目,支持以下配置项:

  • modeproduction或者其他值。默认值:development
  • outputPath:指定编译器的输出目录。默认值:build
  • publicPath:指定输出的publicPath。默认值:/
  • analyze:使用webpack-bundle-analyzer分析输出的包。默认值:false

ers test

运行测试,支持以下配置项:

  • testPathPattern:设置测试文件搜索模式。默认值:/__tests__/**/*.test.js
  • configPath:设置测试的配置文件路径。默认值:/path/to/jest.config.js
  • watch:是否监视测试的更改。默认值:false

ers deploy

部署项目,支持以下配置项:

  • remote:部署的远程服务器地址。默认值:null
  • branch:部署的分支。默认值:master
  • buildScript:用来打包项目的脚本。默认值:npm run build
  • ssh:SSH配置。默认值:null

示例代码

以下代码是一个基本的React应用程序,它使用@everreal/automation-scripts进行构建、测试和部署。

-- -------------------- ---- -------
-
  ------- ---------
  ---------- --------
  ---------- -----
  --------------- -
    -------- ----------
    ------------ ----------
    ---------------- -------
  --
  ---------- -
    -------- ---- -------
    -------- ---- -------
    ------- ---- ------
    --------- ---- -------
  --
  ------------------------------- -
    --------- -
      -------- -
        ------------- ------
      --
      --------- -
        --------- -------------------------
        -------------- ---- --- -------
        ------ -
          ----------- --------------------
          ----------- --------------------
          ------- ----------------
          ------- ----------------------
        -
      -
    -
  -
-
展开代码

结论

@everreal/automation-scripts使得前端项目自动化变得更加容易和简单。它的架构简单,使用方便,可以帮助开发人员节省时间和精力。希望这篇文章能够帮助你理解如何使用该npm包,让你的前端开发变得更加高效、快速,更加自动化、规范化。

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