feat: enhance EncodingValidator with performance optimizations by konradmichalik · Pull Request #34 · move-elevator/composer-translation-validator

konradmichalik · 2025-07-14T12:33:27Z

Summary by CodeRabbit

Documentation
- Updated documentation to clarify that encoding validation no longer includes JSON syntax checks.
- Composer requirements updated: the ext-intl PHP extension is now suggested (not required) for Unicode normalization validation.
Bug Fixes
- Improved encoding validation to skip checks for empty files and optimize detection of invisible characters.
- JSON syntax validation was removed from encoding checks for better clarity and performance.
Tests
- Updated and refocused tests to verify encoding issues and BOM detection, removing checks related to JSON syntax validation.

coderabbitai · 2025-07-14T12:33:33Z

Warning

Rate limit exceeded

@jackd248 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 18 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 94cb94b and a6c8413.

📒 Files selected for processing (2)

composer-require-checker.json (1 hunks)
composer.json (1 hunks)

Walkthrough

This update removes JSON syntax validation from the EncodingValidator, both in code and documentation. The validator now focuses solely on encoding, BOM, invisible characters, and Unicode normalization. The ext-intl extension is moved from a required dependency to a suggestion in composer.json. Related tests and documentation are updated to reflect these changes.

Changes

File(s)	Change Summary
README.md	Updated EncodingValidator description to remove reference to JSON syntax validation.
composer.json	Moved ext-intl from "require" to "suggest" with clarifying message; added symbol whitelist for Normalizer.
src/Validator/EncodingValidator.php	Removed JSON syntax validation logic; added early exits; optimized encoding checks and invisible character detection.
tests/src/Validator/EncodingValidatorTest.php	Renamed and refocused tests to remove JSON syntax validation checks; updated for new validator behavior.
tests/src/Fixtures/config/unsupported.txt	Removed trailing newline; content otherwise unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EncodingValidator
    participant Parser (JsonParser/PhpParser)

    User->>EncodingValidator: processFile(file, parser)
    EncodingValidator->>EncodingValidator: Check if file is empty
    alt Empty
        EncodingValidator-->>User: Return (no issues)
    else Not empty
        EncodingValidator->>EncodingValidator: Check UTF-8 validity
        alt Invalid UTF-8
            EncodingValidator-->>User: Return (UTF-8 issue)
        else Valid UTF-8
            EncodingValidator->>EncodingValidator: Check for BOM
            EncodingValidator->>EncodingValidator: Check invisible characters
            EncodingValidator->>EncodingValidator: Check Unicode normalization
            EncodingValidator-->>User: Return issues (if any)
        end
    end

Possibly related PRs

feat: add EncodingValidator for file encoding and JSON syntax validation #33: Introduced the EncodingValidator with JSON syntax validation, which is now being removed or revised in this PR.

Poem

🐰
No more JSON checks, just pure encoding delight,
BOMs and sneaky chars now quiver in fright.
With ext-intl as a gentle suggestion,
The validator hops on with a lighter impression.
As tests and docs align with care,
This rabbit’s code is lighter than air!

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.

…Normalizer

feat: enhance EncodingValidator with performance optimizations

e95b5c5

konradmichalik added 3 commits July 14, 2025 14:45

feat: add symbol whitelist for Normalizer in composer.json

94cb94b

feat: create composer-require-checker.json with symbol whitelist for …

aa6a5fe

…Normalizer

fix: add newline at end of unsupported.txt for consistency

a6c8413

konradmichalik merged commit d26b001 into main Jul 14, 2025
26 checks passed

coderabbitai bot mentioned this pull request Jul 28, 2025

fix: improve error handling in EncodingValidator and update expected_convention in tests #50

Merged

konradmichalik deleted the encoding-validator branch July 28, 2025 17:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: enhance EncodingValidator with performance optimizations#34

feat: enhance EncodingValidator with performance optimizations#34
konradmichalik merged 4 commits intomainfrom
encoding-validator

konradmichalik commented Jul 14, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 14, 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 Jul 14, 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 Jul 14, 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 Jul 14, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)