Crates.io | llvm-cov-pretty |
lib.rs | llvm-cov-pretty |
version | 0.1.9 |
source | src |
created_at | 2023-06-18 14:08:12.542982 |
updated_at | 2023-10-10 01:31:58.85727 |
description | More beautiful HTML reports for llvm-cov/cargo-llvm-cov |
homepage | https://github.com/dnaka91/llvm-cov-pretty |
repository | https://github.com/dnaka91/llvm-cov-pretty |
max_upload_size | |
id | 893488 |
size | 790,687 |
More beautiful HTML reports for llvm-cov
(cargo-llvm-cov specifically).
This tool is still in its early stages, and the JSON output of llvm-cov
has several quirks and complexities. Therefore, for the time being, always generate the regular HTML report as well and compare the output.
Please file an issue if you find any differences.
Make sure you have cargo-llvm-cov installed.
To build the project from source, you need a recent installation of Rust. The recommended installation method is through rustup. Then open up a terminal and install the project as follows:
cargo install llvm-cov-pretty
The binary will be installed into your $HOME/.cargo/bin
folder by default. Please make sure it is available from your $PATH
.
Arch linux users can use an AUR helper to install the project from the AUR. For example, using paru
:
paru -S llvm-cov-pretty
If you don't want to build the project yourself, you can download pre-build binaries instead. Have a look at the release page and find the appropriate file for your platform.
Before you can use this tool, make sure the following steps are done:
cargo-llvm-cov
, make sure you've run it at least once on your machine in any Rust project. It will jump into interactive mode and install any missing tools that it needs itself.--manifest-path
argument, but make sure you pass the same path to both cargo-llvm-cov
and llvm-cov-pretty
.The tool operates on the JSON output from llvm-cov. As cargo-llvm-cov directly prints those to the standard output, you can pipe the programs together like so:
cargo llvm-cov --json | llvm-cov-pretty
Of course you can do this in two steps as well:
cargo llvm-cov --json > coverage.json
llvm-cov-pretty coverage.json
There are a few extra commands (like generating shell completions) and options (like disabling instantiation annotations) as well. Have a look at the output of llvm-cov-pretty --help
.
To start developing on the project, you'll need a few extra step in addition to the ones described in the From source section.
git submodule update --init
.Then open up a new terminal and execute pnpm run watch
. It will watch the project files and rebuild the stylesheet at assets/style.css
when needed. With that you're ready to hack along.
Before you create a custom build, it's recommended to stop the watch job again and run pnpm run build
once, which will create a minified and optimized version of the stylesheet. It is compiled into the binary during builds.
This project is licensed under the AGPL-3.0 License (or https://www.gnu.org/licenses/agpl-3.0.html).