Skip to content

fix: enhance PrefixFileDetector to support common translation file patterns and update validation configuration#55

Merged
konradmichalik merged 1 commit intomainfrom
fix-prefix-file-detector
Jul 28, 2025
Merged

fix: enhance PrefixFileDetector to support common translation file patterns and update validation configuration#55
konradmichalik merged 1 commit intomainfrom
fix-prefix-file-detector

Conversation

@konradmichalik
Copy link
Copy Markdown
Contributor

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

Summary by CodeRabbit

  • Bug Fixes

    • Improved grouping of translation files for more accurate detection, with refined handling of language prefixes and exclusion of config-related files.

  • Chores

    • Updated test fixture paths and configuration keys for better clarity and consistency.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jul 28, 2025 •
edited
Loading

Walkthrough

The changes refine the logic for grouping translation files in the PrefixFileDetector by introducing more granular and explicit pattern matching, particularly excluding config-related files and handling common translation file names. Additionally, a test fixture YAML was updated to adjust a path and rename a configuration key for clarity.

Changes

Cohort / File(s) Change Summary
Translation File Grouping Logic
src/FileDetector/PrefixFileDetector.php		 Refined the mapTranslationSet method to use three explicit cases for grouping translation files, improving pattern matching and exclusion logic.
Test Fixture Update
tests/Fixtures/examples/key-naming/translation-validator.yaml		 Modified the paths entry to remove a directory prefix and renamed a validator config key from pattern to convention.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

A rabbit hopped through code today,
Sorting files in a clever new way.
Patterns and names now clean and neat,
Configs and settings can't compete!
With YAML tweaked and logic tight,
This bunny's work is pure delight.
🐇✨

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 35d7e54 and 7ca98bd.

📒 Files selected for processing (2)
  • src/FileDetector/PrefixFileDetector.php (1 hunks)
  • tests/Fixtures/examples/key-naming/translation-validator.yaml (1 hunks)
🔇 Additional comments (5)
src/FileDetector/PrefixFileDetector.php (3)

39-42: Language prefix pattern looks correct.

The regex pattern correctly matches language codes (e.g., "de", "en-US", "en_GB") and groups files by their suffix. This handles internationalization file naming conventions well.

43-46: Common translation file pattern matching is comprehensive.

The pattern covers standard translation file prefixes effectively. The translations? pattern nicely handles both singular and plural forms.

47-50: Exclusion pattern validated

Our shell-based tests confirm that the combined regex

preg_match('/^[^.]+\.(xlf|xliff|json|ya?ml|php)$/i', $basename)
&& !preg_match('/(config|validator|setting)/', $basename)

• Includes only the intended translation files (messages.xlf, app.json, strings.yml, labels.php, content.xliff, form.yaml).
• Excludes all “config”, “validator” and “setting” files (app.config.json, validation.validator.xlf, user.setting.yml, database.config.php).

No changes are required.

(Optional) If you need to handle uppercase or mixed-case filenames (e.g. UserSetting.json), you can add the i flag to the exclusion regex:

! preg_match('/(config|validator|setting)/i', $basename)
tests/Fixtures/examples/key-naming/translation-validator.yaml (2)

9-9: Configuration key rename verification passed

The validator now exclusively uses convention for its configuration. All remaining occurrences of pattern are in valid contexts—namely the custom_pattern setting and the internal pattern definitions for each convention—not the deprecated config key.

No further changes needed.

2-2: Fixture path change verified; please confirm configuration key rename

The new fixture path resolves correctly:

  • tests/Fixtures/examples/key-naming exists and contains translation-validator.yaml and other fixtures
  • No remaining ../Fixtures/examples/key-naming references were found

Next step—ensure the validator logic has been updated to use the convention key (replacing pattern) throughout the codebase.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-prefix-file-detector

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 5d91f4a into main Jul 28, 2025
26 of 28 checks passed
@konradmichalik konradmichalik deleted the fix-prefix-file-detector branch July 28, 2025 17:13
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