Skip to content

feat[!!!]: update validation result type from WARNING to ERROR#62

Merged
konradmichalik merged 1 commit intomainfrom
mismatch-validator-error
Jul 29, 2025
Merged

feat[!!!]: update validation result type from WARNING to ERROR#62
konradmichalik merged 1 commit intomainfrom
mismatch-validator-error

Conversation

@konradmichalik
Copy link
Copy Markdown
Contributor

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

If I think about it a little longer, I would classify missing translation entries as errors.

Summary by CodeRabbit

  • Documentation
    • Updated the documentation to show that the MismatchValidator now produces an error (red "ERROR" label) instead of a warning.
  • Tests
    • Updated tests to expect error severity and red color coding for MismatchValidator issues.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jul 29, 2025 •
edited
Loading

Walkthrough

The severity level for mismatches detected by the MismatchValidator was changed from "warning" to "error." This involved updating documentation, removing a method that specified the warning result type, and adjusting tests to expect error-level output and red coloring instead of warning/yellow.

Changes

Cohort / File(s) Change Summary
Documentation Update
docs/validators.md		 Changed the MismatchValidator result type badge from "WARNING" (yellow) to "ERROR" (red).
Validator Logic
src/Validator/MismatchValidator.php		 Removed the resultTypeOnValidationFailure() method, which previously returned a warning result type.
Test Update
tests/src/Validator/MismatchValidatorTest.php		 Updated tests to expect "Error" and red color tags instead of "Warning" and yellow, reflecting new severity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MismatchValidator
    participant Output

    User->>MismatchValidator: Validate input
    MismatchValidator-->>Output: Report error (was warning)
    Output-->>User: Display error message (red)
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

Poem

A validator hopped by,
With warnings in its eye,
But now it shouts "Error!"—
In bold red, not yellow terror.
Bugs beware, the stakes are high,
For mismatches, you can’t just pass by!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 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 76d0f14 and 2364736.

📒 Files selected for processing (3)
  • docs/validators.md (1 hunks)
  • src/Validator/MismatchValidator.php (0 hunks)
  • tests/src/Validator/MismatchValidatorTest.php (1 hunks)
💤 Files with no reviewable changes (1)
  • src/Validator/MismatchValidator.php
🔇 Additional comments (2)
docs/validators.md (1)

383-383: LGTM! Documentation correctly updated to reflect severity level change.

The badge update from WARNING (yellow) to ERROR (red) accurately reflects the change in the MismatchValidator's behavior, aligning with the PR objective to treat missing translation entries as errors for stricter validation.

tests/src/Validator/MismatchValidatorTest.php (1)

315-318: LGTM! Test assertions correctly updated for error severity level.

The test assertions have been properly updated to expect "Error" instead of "Warning" and red color formatting instead of yellow, which aligns with the MismatchValidator's new behavior of treating missing translations as errors.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch mismatch-validator-error

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 generate unit tests to generate unit tests for 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 b7e85bd into main Jul 29, 2025
25 of 28 checks passed
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