Feat/add-fail-comparer-options

[NelsonBN]

Added error handling options to improve the experience in CI/CD

Checklist before requesting a review

• I have performed a self-review of my code.
• Implemented tests for new features.
• I tested the features already implemented.
• Added usage examples in the readme.

[github-actions]

Test Summary

196 tests   196 ✅  0s ⏱️
  1 suites    0 💤
  1 files      0 ❌

Results for commit 907438d.

♻️ This comment has been updated with latest results.

[github-actions]

Package	Line Rate	Branch Rate	Complexity	Health
PBReporter	97%	82%	881	✔
Summary	97% (851 / 880)	82% (607 / 742)	881	✔

[github-actions]

🚀 Stryker report generated 🚀

To more details: https://dashboard.stryker-mutator.io/reports/github.com/TechNobre/PowerUtils.BenchmarkDotnet.Reporter/feat/add-fail-comparer-options-49

[sonarqubecloud]

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Copilot]

Pull Request Overview

This PR adds two new error-handling CLI options to the compare command, enabling configurable exit codes for warnings and threshold hits, updates the command implementation, tests, and documentation accordingly.

• Introduce --fail-on-warnings and --fail-on-threshold-hit options and wire them into ComparerCommand.Execute
• Update existing tests and add new tests for the error-handling behavior
• Refresh README and constants to reflect new exit codes and usage

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/Options/FailOnWarningsOption.cs & FailOnThresholdHitOption.cs	New option classes defining the two error-handling flags
src/Commands/ComparerCommand.cs	Extend Execute signature and implement exit-code logic
src/Models/Constants.cs	Define new exit-code constants for warnings and threshold hits
tests/**/*ToolCommandsTest.cs & OptionsTests.cs/etc.	Update expected option counts, invoke new flags in tests
tests/**/*ComparerCommandTests.cs	Extend command invocation in existing tests; missing combined scenario
README.md	Add documentation for new error-handling options and exit codes

Comments suppressed due to low confidence (4)

README.md:186

• The description for --fail-on-warnings is incorrect: it should mention exiting on warnings rather than thresholds.

* (`-fw`, `--fail-on-warnings`): Exit with error code when any threshold is hit during comparison. **[default: disabled]**

README.md:255

• The exit-code values listed here (1 and 2) don’t match the constants (WARNING = 2, THRESHOLD_HIT = 3). Update to align with the actual codes.

* **1**: Warnings detected (when `--fail-on-warnings` is enabled)

tests/PowerUtils.BenchmarkDotnet.Reporter.Tests/Commands/ComparerCommandTests.cs:933

• Add a test covering the scenario where both --fail-on-warnings and --fail-on-threshold-hit are enabled and both warnings and threshold hits occur, to verify that warnings take priority.

    public void When_Comparison_Generate_Warning_And_FailOnWarnings_Is_False_Should_Return_Success_ExitCode()

tests/PowerUtils.BenchmarkDotnet.Reporter.Tests/Options/OptionsTests.cs:136

• [nitpick] Two statements are on the same line—split into separate lines for readability.

        var compareCommand = toolCommands.Subcommands.Single(c => c.Name == "compare");        var option = compareCommand.Options.Single(o => o.Name == "--fail-on-warnings");

[NelsonBN]

🎉 This PR is included in version 1.4.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀