9 个版本
0.1.9 | 2023年10月10日 |
---|---|
0.1.8 | 2023年10月6日 |
0.1.7 | 2023年9月25日 |
0.1.6 | 2023年8月23日 |
0.1.3 | 2023年6月23日 |
#120 在 测试 中
每月 101 次下载
720KB
1.5K SLoC
💄 llvm-cov-pretty
为 llvm-cov
(cargo-llvm-cov 专门) 提供更美观的 HTML 报告。
- 支持暗色主题(自动根据浏览器设置切换)。
- 语法高亮。
- 减少了实例化注释的混乱。
- 更多颜色,因为为什么不行。
- 进度条(如 grcov 中所示)。
关于稳定性的说明
此工具仍处于早期阶段,且 llvm-cov
的 JSON 输出存在一些怪癖和复杂性。因此,目前,请始终同时生成常规 HTML 报告并比较输出。
如果您发现任何差异,请提交问题。
安装
请确保您已安装 cargo-llvm-cov。
从源代码
要从源代码构建项目,您需要一个最新的 Rust 安装。推荐安装方法是使用 rustup。然后打开终端并按以下方式安装项目
cargo install llvm-cov-pretty
二进制文件将默认安装到您的 $HOME/.cargo/bin
文件夹中。请确保它可以从您的 $PATH
中访问。
从 AUR
Arch Linux 用户可以使用 AUR 辅助工具 从 AUR 安装项目。例如,使用 paru
paru -S llvm-cov-pretty
预构建的二进制文件
如果您不想自己构建项目,您可以下载预构建的二进制文件。查看 发布页面 并找到适合您平台的适当文件。
需求
在使用此工具之前,请确保以下步骤已完成
- 除了安装
cargo-llvm-cov
之外,请确保您已在您的机器上至少运行过一次它,在任何 Rust 项目中。它将进入交互模式并自行安装所需的任何工具。 - 预计您处于一个Rust项目的上下文中。请确保您在终端位于Rust项目目录中运行程序。
- 然而,您可以传递
--manifest-path
参数,但请确保您将相同的路径传递给cargo-llvm-cov
和llvm-cov-pretty
。
- 然而,您可以传递
使用方法
该工具操作于 llvm-cov 的JSON输出。由于 cargo-llvm-cov 直接将这些输出到标准输出,您可以像这样将程序连接起来
cargo llvm-cov --json | llvm-cov-pretty
当然,您也可以分两步进行
cargo llvm-cov --json > coverage.json
llvm-cov-pretty coverage.json
还有一些额外的命令(如生成shell补全)和选项(如禁用实例化注释)。查看 llvm-cov-pretty --help
的输出。
开发
要开始开发该项目,您需要在“从源码安装”部分描述的步骤之外进行一些额外的步骤。
- 安装Node.js的最新版本和PNPM。
- 确保使用
git submodule update --init
初始化所有子模块。
然后打开一个新的终端并执行 pnpm run watch
。它将监视项目文件,并在需要时重新构建位于 assets/style.css
的样式表。有了这个,您就可以开始修改了。
在创建自定义构建之前,建议您再次停止监视任务并运行一次 pnpm run build
,这将创建样式表的压缩和优化版本。它在构建过程中编译到二进制文件中。
许可证
本项目受 AGPL-3.0 许可证(或 https://www.gnu.org/licenses/agpl-3.0.html)的约束。
依赖项
~17–30MB
~455K SLoC