feat!: Better error reporting in hugr-cli.

[zrho]

This PR streamlines the error reporting in hugr-cli, displaying error source trails and setting up the tracing crate. For that, some error trait implementations were migrated to thiserror. The PR also simplifies the clap structures by pulling out the verbosity level from the individual commands. The commands should use tracing macros instead of relying on filtering for verbosity themselves.

BREAKING CHANGE: Reorganised clap commands and errors in hugr-cli which is only visible when it is used as a library.

[codecov]

Codecov Report

Attention: Patch coverage is 71.18644% with 17 lines in your changes missing coverage. Please review.

Project coverage is 82.08%. Comparing base (8a17e7c) to head (870079a).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
hugr-cli/src/main.rs	76.19%	10 Missing ⚠️
hugr-cli/src/extensions.rs	33.33%	0 Missing and 4 partials ⚠️
hugr-cli/src/validate.rs	71.42%	2 Missing ⚠️
hugr-cli/src/mermaid.rs	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2318      +/-   ##
==========================================
- Coverage   82.09%   82.08%   -0.02%     
==========================================
  Files         241      240       -1     
  Lines       43893    43882      -11     
  Branches    39731    39720      -11     
==========================================
- Hits        36035    36020      -15     
- Misses       5878     5879       +1     
- Partials     1980     1983       +3     

Flag	Coverage Δ
python	85.46% <ø> (ø)
rust	81.72% <71.18%> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[hugrbot]

This PR contains breaking changes to the public Rust API.

cargo-semver-checks summary

--- failure inherent_method_missing: pub method removed or renamed ---

Description:
A publicly-visible method or associated fn is no longer available under its prior name. It may have been renamed or removed entirely.
      ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
     impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.41.0/src/lints/inherent_method_missing.ron

Failed in:
ValArgs::verbosity, previously in file /home/runner/work/hugr/hugr/BASELINE_BRANCH/hugr-cli/src/validate.rs:53
MermaidArgs::verbosity, previously in file /home/runner/work/hugr/hugr/BASELINE_BRANCH/hugr-cli/src/mermaid.rs:78

--- failure struct_pub_field_missing: pub struct's pub field removed or renamed ---

Description:
A publicly-visible struct has at least one public field that is no longer available under its prior name. It may have been renamed or removed entirely.
      ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
     impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.41.0/src/lints/struct_pub_field_missing.ron

Failed in:
field other_args of struct ValArgs, previously in file /home/runner/work/hugr/hugr/BASELINE_BRANCH/hugr-cli/src/validate.rs:24
field other_args of struct MermaidArgs, previously in file /home/runner/work/hugr/hugr/BASELINE_BRANCH/hugr-cli/src/mermaid.rs:36

--- warning enum_missing: pub enum removed or renamed ---

Description:
A publicly-visible enum cannot be imported by its prior path. A `pub use` may have been removed, or the enum itself may have been renamed or removed entirely.
      ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
     impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.41.0/src/lints/enum_missing.ron

Failed in:
enum hugr_cli::CliArgs, previously in file /home/runner/work/hugr/hugr/BASELINE_BRANCH/hugr-cli/src/lib.rs:77

--- warning struct_missing: pub struct removed or renamed ---

Description:
A publicly-visible struct cannot be imported by its prior path. A `pub use` may have been removed, or the struct itself may have been renamed or removed entirely.
      ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
     impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.41.0/src/lints/struct_missing.ron

Failed in:
struct hugr_cli::OtherArgs, previously in file /home/runner/work/hugr/hugr/BASELINE_BRANCH/hugr-cli/src/lib.rs:114

[aborgna-q]

What's the reason for swapping derive_more::Error with thiserror?

I was hoping we'd be able to drop the latter at some point :/

[aborgna-q]

Another cool thing to setup for error reporting is human-panic. It gives a user-friendly message on panic, suggesting submitting a bugreport with the generated error dump.

[zrho]

The thiserror one was mostly for consistency as a driveby when setting sources since we've used thiserror in other places and it appears to be the "standard". Wasn't aware of the ambition to remove it. Luckily it's not visible in the API anyway, so we might still do that in the future.