Skip to content

Unit info translation support - #1121

Closed
its-sii wants to merge 3 commits into
openfrontio:mainfrom
its-sii:unit-info-translation-support
Closed

its-sii wants to merge 3 commits into
openfrontio:mainfrom
its-sii:unit-info-translation-support

Conversation

@its-sii

@its-sii its-sii commented Jun 9, 2025

Copy link
Copy Markdown
Contributor

Description:

Adding translation support for the unit info modal.

Please complete the following:

  • I have added screenshots for all UI updates
  • I process any text displayed to the user through translateText() and I've added it to the en.json file
  • I have added relevant tests to the test directory
  • I confirm I have thoroughly tested these changes and take full responsibility for any bugs introduced
  • I understand that submitting code with bugs that could have been caught through manual testing blocks releases and new features for all contributors

Please put your Discord username so you can be contacted if a bug or regression is found:

sii

@coderabbitai

coderabbitai Bot commented Jun 9, 2025 •

Copy link
Copy Markdown
Contributor

Walkthrough

This change adds new English translation keys for the unit info modal and updates the UnitInfoModal component to use these keys through a translation function, replacing previously hardcoded English strings. No logic or control flow is changed; only the user-facing text is now localized.

Changes

Files Change Summary
resources/lang/en.json Added "unit_info_modal" section with four new translation keys: "structure_info", "unit_type_unknown", "close", "cooldown".
src/client/graphics/layers/UnitInfoModal.ts Replaced hardcoded English UI strings with translation function calls using the new keys.

Possibly related PRs

  • Unit menu #867: Originally introduced the UnitInfoModal component; this PR builds directly on that code by adding localization.
  • Add close label #949: Adds a "close" localization key for a different modal; both PRs add translation keys for modal buttons but in different contexts.

Suggested labels

Translation - Revision

Suggested reviewers

  • evanpelle

Poem

In the modal’s gentle light,
Words now shift and take new flight.
"Close" and "Info"—clear and bright,
Translated for all, just right.
With every string, a world unlocked,
Code and language, neatly stocked.
🌏✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-09T19_07_17_887Z-debug-0.log


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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5e821be and 36f50aa.

📒 Files selected for processing (2)
  • resources/lang/en.json (1 hunks)
  • src/client/graphics/layers/UnitInfoModal.ts (3 hunks)
🔇 Additional comments (6)
resources/lang/en.json (1)

405-410: LGTM! Clean translation key additions.

The new translation keys follow the established naming convention and provide clear, descriptive English text for the unit info modal components.

src/client/graphics/layers/UnitInfoModal.ts (5)

3-3: Good addition of translation import.

The translateText import follows the established pattern and enables internationalization support.


137-137: Correct translation implementation for modal title.

Properly replaces hardcoded "Structure Info" with the translation key.


148-149: Good translation implementation for cooldown label.

Properly replaces hardcoded "Cooldown" text with the translation key.


161-161: Excellent addition of translation to button title attribute.

Good attention to detail in translating the title attribute for accessibility.


164-164: Correct translation implementation for close button text.

Properly replaces hardcoded "Close" with the translation key.

Comment on lines +140 to +144
<strong>Type:</strong> ${translateText(
"unit_type." + this.unit.type?.().toLowerCase(),
) ?? translateText("unit_info_modal.unit_type_unknown")}
<strong>Type:</strong> ${this.unit.type?.() ??
translateText("unit_info_modal.unit_type_unknown")}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix duplicate and malformed unit type display code.

There are two conflicting implementations for displaying the unit type. The code has both a translated version and what appears to be leftover untranslated code.

Apply this diff to fix the duplicate code:

-        <div style="margin-bottom: 4px;">
-          <strong>Type:</strong> ${translateText(
-            "unit_type." + this.unit.type?.().toLowerCase(),
-          ) ?? translateText("unit_info_modal.unit_type_unknown")}
-          <strong>Type:</strong> ${this.unit.type?.() ??
-          translateText("unit_info_modal.unit_type_unknown")}
-        </div>
+        <div style="margin-bottom: 4px;">
+          <strong>Type:</strong> ${translateText(
+            "unit_type." + this.unit.type?.().toLowerCase(),
+          ) ?? translateText("unit_info_modal.unit_type_unknown")}
+        </div>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<strong>Type:</strong> ${translateText(
"unit_type." + this.unit.type?.().toLowerCase(),
) ?? translateText("unit_info_modal.unit_type_unknown")}
<strong>Type:</strong> ${this.unit.type?.() ??
translateText("unit_info_modal.unit_type_unknown")}
<div style="margin-bottom: 4px;">
<strong>Type:</strong> ${translateText(
"unit_type." + this.unit.type?.().toLowerCase(),
) ?? translateText("unit_info_modal.unit_type_unknown")}
</div>
🤖 Prompt for AI Agents
In src/client/graphics/layers/UnitInfoModal.ts around lines 140 to 144, there is
duplicate and conflicting code displaying the unit type, with one translated and
one untranslated version. Remove the duplicate untranslated line and keep only
the translated unit type display using translateText with the fallback for
unknown types. Ensure the code cleanly displays the translated unit type without
redundancy.

@github-project-automation github-project-automation Bot moved this from Triage to Development in OpenFront Release Management Jun 9, 2025
@its-sii its-sii closed this Jun 9, 2025
@github-project-automation github-project-automation Bot moved this from Development to Complete in OpenFront Release Management Jun 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Complete

Development

Successfully merging this pull request may close these issues.

1 participant