npm 包 travis-size-report 使用教程

阅读时长 3 分钟读完

简介

travis-size-report是一个npm包,它可以用于在CI/CD中查看你的项目的JS包大小。这个包是用Node.js编写的,支持使用成本不高的脚本语言。它通过使用 size-limit 库来测量你的代码的大小,并生成相应的报告。

安装

你可以通过执行下面的命令来安装这个npm包。

如何使用

安装完成后,你可以在项目中使用以下命令来检查你的代码包的大小。

在你的CI/CD文件中添加如下命令:

这行命令将会在你的CI/CD构建过程中运行,然后生成一个HTML报告。

生成报告

当你在本地运行 travis-size-report 命令之后,它将会生成一个HTML报告,里面包含了你的项目各个JS包的大小和依赖关系。它通过将数据保存到一个单独的.json文件中,并将其作为报告数据源。

运行该命令后,它将在根目录下生成一个 size-limit-report.html 文件。你可以双击它在浏览器中查看你的报告。

你可以通过钩子命令 onFinish 在你的CI/CD环境中自定义报告输出目录。

你也可以使用 size-limit 官网提供的网页版 Size Limit Report 来查看你的项目的JS包大小。

示例

这个简单的示例演示了如何在项目中使用travis-size-report。

myapp项目的SilentLogFile.js文件:

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

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

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

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

在该项目的根目录下,创建一个 size-limit.config.json 文件。

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

总结

通过使用 travis-size-report 包,你可以很方便地在CI/CD中查看你的项目的包大小。同时,它所提供的HTML报告也能让你清晰地了解你的JS包之间的相互依赖关系。对于一个前端工程师来说,深入了解和熟练掌握这个工具的使用,将会使你的项目更加稳定,更加高效。

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