Go to file
Wojciech Kozlowski 1753203c7d
Some checks failed
Cargo CI / Build and Test (pull_request) Successful in 2m1s
Cargo CI / Lint (pull_request) Failing after 1m4s
Remove unused variants
2024-08-24 14:58:30 +02:00
.gitea Update rust toolchain to 1.80 2024-08-24 14:35:38 +02:00
examples/musicbrainz_api The MusicBrainz API search call should use the MBID if available (#171) 2024-03-17 17:18:06 +01:00
src Remove unused variants 2024-08-24 14:58:30 +02:00
tests Add a MusicBrainz API (#163) 2024-03-16 16:57:50 +01:00
.gitignore Add integration tests to CI (#82) 2024-01-06 16:14:07 +01:00
build.rs Fix a new clippy lint 2024-08-24 14:45:23 +02:00
Cargo.lock Add a MusicBrainz API (#163) 2024-03-16 16:57:50 +01:00
Cargo.toml Create examples of using the MusicBrainz API (#170) 2024-03-17 14:19:30 +01:00
README.md Update rust toolchain to 1.79 (#176) 2024-06-16 16:38:35 +02:00

Music Hoard

Developing

Pre-requisites

musicbrainz-api

This feature requires the openssl system library.

On Fedora:

sudo dnf install openssl-devel

Usage notes

Text selection

To select and copy text use the terminal-specific modifier key (on Linux this is usually the Shift key).

Code Coverage

Pre-requisites

rustup component add llvm-tools-preview
cargo install grcov

Generating Code Coverage

env CARGO_TARGET_DIR=codecov \
    rm -rf ./codecov/debug/{coverage,profraw}
env CARGO_TARGET_DIR=codecov \
    cargo clean -p musichoard
env RUSTFLAGS="-C instrument-coverage" \
    LLVM_PROFILE_FILE="codecov/debug/profraw/musichoard-%p-%m.profraw" \
    CARGO_TARGET_DIR=codecov \
    BEETSDIR=./ \
    cargo test --all-features --all-targets
grcov codecov/debug/profraw \
      --binary-path ./codecov/debug/ \
      --output-types html \
      --source-dir . \
      --ignore-not-existing \
      --ignore "build.rs" \
      --ignore "examples/*" \
      --ignore "tests/*" \
      --ignore "src/main.rs" \
      --ignore "src/bin/musichoard-edit.rs" \
      --excl-line "^#\[derive" \
      --excl-start "GRCOV_EXCL_START|mod tests \{" \
      --excl-stop "GRCOV_EXCL_STOP" \
      --output-path ./codecov/debug/coverage/
xdg-open codecov/debug/coverage/index.html

Note that some changes may not be visible until codecov/debug/coverage is removed and the grcov command is rerun.

For most cases cargo clean can be replaced with rm -rf ./codecov/debug/{coverage,profraw}.

Benchmarks

Pre-requisites

rustup toolchain install nightly

Running benchmarks

env BEETSDIR=./ rustup run nightly cargo bench --all-features --all-targets