Tracing Instrument Mock

The tracing::instrument proc macro breaks the code coverage. There is an open issue about it. While there's no solution for this issue, a workaround is to disable the instrument macro when tests with code coverage are run. his crate is just a mock of the tracing::instrument macro that does nothing and can replace the tracing::instrument macro when running with code coverage enabled.

You can select which version of the macro to use using the coverage configuration flag:

#[cfg(not(coverage))]
pub use tracing::instrument;
#[cfg(coverage)]
pub use tracing_instrument_mock::instrument;

Then, when instrumenting functions you can simply do

#[instrument]
fn my_function() {
  println!("Hello, world!");
}

Lints

cargo clippy --workspace --all-targets

and this in your IDE:

cargo clippy --workspace --all-targets --message-format=json

Pre-commit usage

1. If not installed, install with your package manager, or pip install --user pre-commit
2. Run pre-commit autoupdate to update the pre-commit config to use the newest template
3. Run pre-commit install to install the pre-commit hooks to your local environment