Skip to content
This repository was archived by the owner on Jul 31, 2025. It is now read-only.

fix: ignore blank entries in locales - #43

Merged
Derek Kaser (dkaser) merged 1 commit into
mainfrom
translator
May 20, 2025
Merged

fix: ignore blank entries in locales#43
Derek Kaser (dkaser) merged 1 commit into
mainfrom
translator

Conversation

@dkaser

@dkaser Derek Kaser (dkaser) commented May 20, 2025

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Refactor
    • Improved handling of language files for translations, resulting in more consistent and reliable display of localized text. No changes to visible translation features or user interface.

@coderabbitai

coderabbitai Bot commented May 20, 2025

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

A new private static method, flattenArray, was introduced to recursively flatten nested associative arrays into dot-separated key arrays, filtering for non-empty strings. The Translator class constructor was refactored to use this method for handling locale files, simplifying and streamlining the language merging and flattening process. The translation method remains unchanged.

Changes

File(s) Change Summary
src/usr/local/emhttp/plugins/tailscale/include/Tailscale/Translator.php Added private static flattenArray method; refactored constructor to use it for flattening and merging locales

Poem

In the warren of code, a new path’s unfurled,
Arrays once nested, now flat and pearled.
Dotty keys hop, translation made neat,
Locale bunnies gather, their work now complete.
With every string found, the language will sing—
Flattened and merged for the joy it will bring!
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 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 265a85f and d75ddd4.

📒 Files selected for processing (1)
  • src/usr/local/emhttp/plugins/tailscale/include/Tailscale/Translator.php (2 hunks)
🔇 Additional comments (4)
src/usr/local/emhttp/plugins/tailscale/include/Tailscale/Translator.php (4)

10-27: Well implemented recursive flattening with empty string filtering

The newly added flattenArray method effectively handles the PR objective of ignoring blank entries in locales. The implementation recursively traverses nested arrays, builds dot-notation keys, and filters out non-string and empty values. The PHPDoc annotations clearly document the parameter and return types.


41-41: Good use of the new flattenArray method

This change properly applies the new method to process the English locale file, which serves as the base language set.


45-46: Effective locale merging strategy

The code now correctly:

  1. Flattens the current locale using the same method as the base locale
  2. Uses array_replace to merge translations, which is more appropriate than the previous recursive approach

This implementation ensures consistent handling of nested structures while properly filtering out empty strings.


49-49: Simplified assignment of language array

The final assignment is now more straightforward, directly using the pre-processed array.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch translator
  • Post Copyable Unit Tests in Comment

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

@dkaser
Derek Kaser (dkaser) merged commit 001e4ea into main May 20, 2025
@dkaser
Derek Kaser (dkaser) deleted the translator branch May 20, 2025 04:27
@coderabbitai coderabbitai Bot mentioned this pull request Jun 4, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant