Skip to content

refactor: enhance validation output to differentiate between errors and warnings#21

Merged
konradmichalik merged 2 commits intomainfrom
result-message
Jul 10, 2025
Merged

refactor: enhance validation output to differentiate between errors and warnings#21
konradmichalik merged 2 commits intomainfrom
result-message

Conversation

@konradmichalik
Copy link
Copy Markdown
Contributor

@konradmichalik konradmichalik commented Jul 10, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Bug Fixes

    • Improved compact output to only show detailed results when errors are present, skipping detailed output for warnings alone.
    • Enhanced summary messages to clearly distinguish between errors and warnings, and indicate dry-run mode when applicable.
    • Adjusted output styling for warnings and errors, with clearer hints for verbose and strict modes.

  • Tests

    • Updated test expectations to match revised summary messages for both error and warning scenarios.
    • Added new tests covering various rendering scenarios including compact mode, dry-run, strict mode hints, and verbosity levels.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jul 10, 2025 •
edited
Loading

Walkthrough

The changes refine the ValidationResultCliRenderer class by adjusting the output logic for compact and summary rendering, clarifying when detailed output is shown, and improving message clarity and styling. Corresponding test assertions were updated and expanded to cover new warning and error rendering scenarios, ensuring alignment between implementation and test expectations.

Changes

File(s) Change Summary
src/Result/ValidationResultCliRenderer.php Refined compact output to show details only for errors, improved summary message logic and styling, added dry-run and strict mode handling.
tests/src/Result/OutputTest.php Updated test to expect refined error summary message in CLI output.
tests/src/Result/ValidationResultCliRendererTest.php Updated and added multiple tests to cover new warning/error rendering behaviors, dry-run, strict mode hints, and verbosity effects.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ValidationResultCliRenderer
    participant IO

    User->>ValidationResultCliRenderer: renderCompactOutput()
    alt If errors present
        ValidationResultCliRenderer->>IO: Output detailed error info
    else No errors (only warnings)
        ValidationResultCliRenderer-->>User: Return early, no detailed output
    end

    User->>ValidationResultCliRenderer: renderSummary()
    ValidationResultCliRenderer->>IO: Output summary message (styled or plain, based on result type, dry-run, strict mode, verbosity)
Loading

Possibly related PRs

Poem

A bunny hopped through code so neat,
Tweaked warnings, errors—no repeat!
Now outputs shine with clearer light,
Tests aligned, all wording right.
In summary boxes, colors bloom—
The CLI now banishes gloom!
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9bc1c96 and ca15568.

📒 Files selected for processing (1)
  • tests/src/Result/ValidationResultCliRendererTest.php (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Code Coverage Report
  • GitHub Check: Code Coverage Report
  • GitHub Check: cgl
🔇 Additional comments (8)
tests/src/Result/ValidationResultCliRendererTest.php (8)

158-158: Updated assertion aligns with enhanced warning message format.

The test expectation correctly reflects the new behavior where warnings show "completed with warnings" instead of "failed".

498-521: Well-structured test for compact mode warning behavior.

The test correctly verifies that warnings don't show detailed output in compact mode, which aligns with the enhanced differentiation between errors and warnings.

523-546: Comprehensive test for error display in compact mode.

The test properly validates that errors still show detailed output in compact mode, maintaining the expected behavior for critical issues.

548-563: Effective test for dry-run mode message variations.

The test correctly verifies the specific dry-run failure message format, ensuring proper user feedback in dry-run scenarios.

565-581: Proper test for strict mode hint display.

The test correctly validates that the strict mode hint is shown when not in strict mode, providing helpful guidance to users.

583-599: Appropriate test for strict mode hint suppression.

The test correctly verifies that the strict mode hint is not shown when already in strict mode, avoiding redundant information.

601-619: Good test for compact warning output formatting.

The test properly validates that warnings use simple text output without warning box formatting in compact mode.

621-638: Solid test for verbose warning output formatting.

The test correctly verifies that warnings use warning box formatting in verbose mode, ensuring appropriate visual distinction.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@konradmichalik konradmichalik merged commit 3c076ac into main Jul 10, 2025
22 of 24 checks passed
This was referenced Jul 10, 2025
Merged
Merged
@konradmichalik konradmichalik deleted the result-message branch July 28, 2025 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@konradmichalik