style: enhance code formatting and improve readability in validation commands by konradmichalik · Pull Request #8 · move-elevator/composer-translation-validator

konradmichalik · 2025-06-27T12:06:22Z

Summary by CodeRabbit

New Features
- Improved console output for validation results by visually grouping issues and errors by file, using separators and color formatting for better readability.
Bug Fixes
- Corrected the order of parameters in validation logic to ensure accurate validator instantiation.
Tests
- Added a test case with duplicate translation keys to verify duplicate detection functionality.

…commands

coderabbitai · 2025-06-27T12:07:01Z

Warning

Rate limit exceeded

@jackd248 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 30 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between cfb0eed and a3344c6.

⛔ Files ignored due to path filters (1)

docs/console.jpg is excluded by !**/*.jpg

📒 Files selected for processing (4)

src/Command/ValidateTranslationCommand.php (4 hunks)
src/Validator/DuplicatesValidator.php (2 hunks)
src/Validator/MismatchValidator.php (3 hunks)
src/Validator/SchemaValidator.php (3 hunks)

Walkthrough

The changes update the parameter order and logic in the validateAndInstantiate method in ValidateTranslationCommand.php, introduce early validator instantiation, and enhance output formatting. Additionally, the table rendering in both DuplicatesValidator and SchemaValidator is improved to visually separate entries by file. A test XLIFF file is updated to include a duplicate key.

Changes

File(s)	Change Summary
src/Command/ValidateTranslationCommand.php	Corrected parameter order in `validateAndInstantiate`, added early validator instantiation, improved output formatting, and adjusted method signature.
src/Validator/DuplicatesValidator.php src/Validator/SchemaValidator.php	Enhanced table rendering to visually separate entries by file using `TableSeparator` and improved row formatting.
tests/Build/app/Language/XLIFF-fail/locallang.xlf	Added a duplicate `<trans-unit>` element to introduce a repeated translation key for testing.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant ValidateTranslationCommand
    participant FileDetector
    participant Validator

    User->>CLI: Run validate-translation command
    CLI->>ValidateTranslationCommand: Execute
    ValidateTranslationCommand->>FileDetector: validateAndInstantiate(type, className)
    ValidateTranslationCommand->>Validator: validateAndInstantiate(type, className)
    ValidateTranslationCommand->>Validator: Validate translation files
    Validator-->>ValidateTranslationCommand: Validation results
    ValidateTranslationCommand->>CLI: Render issues with improved formatting

Possibly related PRs

#7: Refactored ValidateTranslationCommand.php, introduced utility classes, and restructured validation flow, directly related to the method signature and validation changes in this PR.
#3: Added support for multiple validators and the validator option in ValidateTranslationCommand.php, which this PR further refines.
#2: Enhanced validation logic and output formatting in ValidateTranslationCommand.php, related to this PR's improvements in validation and formatting.

Poem

Hopping through code with colors anew,
Tables now sparkle in blue and in hue.
Duplicates sorted, each file stands apart,
Validators checked at the very start.
With every command, translations align—
This bunny’s proud of the output design!
🐇✨

✨ 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.

style: enhance code formatting and improve readability in validation …

cfb0eed

…commands

konradmichalik added 3 commits June 27, 2025 14:07

style: improve code formatting and consistency in validation commands

eb5f67d

style: enhance console output formatting and improve table header styles

1b416ee

docs: update screenshot

a3344c6

konradmichalik merged commit f9582a2 into main Jun 27, 2025
2 checks passed

This was referenced Jun 27, 2025

feat: add YAML support #9

Merged

test: add unit tests #10

Merged

konradmichalik deleted the style-improvements branch June 28, 2025 09:16

This was referenced Jul 1, 2025

feat: add json output format #11

Merged

feat: implement output format handling with CLI and JSON renderers #14

Merged

feat: enhance validation command options to allow skipping and specifying validators #16

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

style: enhance code formatting and improve readability in validation commands#8

style: enhance code formatting and improve readability in validation commands#8
konradmichalik merged 4 commits intomainfrom
style-improvements

konradmichalik commented Jun 27, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 27, 2025 •

edited

Loading

Rate limit exceeded

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

konradmichalik commented Jun 27, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

konradmichalik commented Jun 27, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 27, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)