|0.1.9||Oct 10, 2023|
|0.1.8||Oct 6, 2023|
|0.1.7||Sep 25, 2023|
|0.1.6||Aug 23, 2023|
|0.1.3||Jun 23, 2023|
#58 in Testing
52 downloads per month
More beautiful HTML reports for
llvm-cov (cargo-llvm-cov specifically).
- Dark theme support (switches automatically based on your browser setting).
- Syntax highlighting.
- Reduced clutter from instantiation annotations.\
- More colors, because why not.
- Progress bars (like in grcov).
A note on stability
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
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:
- In addition to installing
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.
- It is expected that you are in the context of a Rust project. Ensure you invoke the program while located in a Rust project in your terminal.
- However, you can pass the
--manifest-pathargument, but make sure you pass the same path to both
- However, you can pass the
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
To start developing on the project, you'll need a few extra step in addition to the ones described in the From source section.
- Install a recent version of Node.js and PNPM.
- Ensure all submodules are initialized with
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.