npm 包 @baransu/carbon-cli 使用教程

阅读时长 3 分钟读完

Carbon 是一个网络应用程序性能监测工具,可帮助前端开发人员实时监控网站性能指标。而 @baransu/carbon-cli 是 Carbon 的一个 NPM 包,提供了命令行工具来轻松收集,可视化和比较性能基准数据。本教程将详细介绍如何使用这个包。

前置条件

在开始使用此包之前,您需要确保已安装以下软件:

  • Node.js(v10.0 或更高版本)
  • npm(建议 v5.2 或更高版本)

安装

您可以使用 npm 命令安装此包:

使用

命令行选项

  • --url:被测试页面的 URL。可以提供多个 URL,用空格分隔。
  • --out:指定输出目录。
  • --prefix:用来识别 URL 的前缀。这个选项将从 URL 中去除,以便更清晰地报告。
  • --name:方便标识测试运行。
  • --run:运行测试。

示例

以下是如何使用 carbon-cli 命令行工具的示例:

运行完上述命令后,您将在 ./report 目录中看到 Carbon 的 HTML 报告。

高级用法

配置文件

除了如上的命令行选项,您还可以在项目的根目录中创建一个 .carbonrc 文件来配置 carbon-cli。下面是一个 .carbonrc 文件的示例:

运行以下命令即可开始测试:

carbon-cli 将搜索 .carbonrc 文件并使用其中的配置进行测试。

API

此包还可以通过 Node.js API 进行调用。

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

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

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

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

使用 API 调用的详细信息可参见 carbon-cli API 文档

总结

通过 carbon-cli 命令行工具和 API,您可以快速轻松地收集,可视化和比较性能基准数据。您可以根据需要自定义报告输出和测试方式,并使用 .carbonrc 文件来简化配置。尝试使用此包,以帮助您更好地监控和优化您的网站性能,并提供卓越的用户体验!

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

纠错
反馈