jmix-add-i18n-keys

name	jmix-add-i18n-keys
description	Add complete Jmix message keys for entities, enums, views, actions, and validation text.

Add I18n Keys

Use this skill whenever adding user-visible text, entities, enum values, views, or validation messages.

Steps

1. Find all locale files in the application message bundle.
2. Add the same keys to every locale file.
3. Use entity keys for entity captions and attributes.
4. Use enum keys for every enum constant.
5. Use view-local keys for titles, button text, labels, and dialog text.
6. Use msg:// in XML descriptors.
7. Use MessageBundle in view controllers and Messages in services/beans.
8. Check every msg:// reference against the bundle key exactly; key lookup is case-sensitive.
9. Use full msg://<message-group>/<key> references when the key belongs to another message group.

Key Patterns

com.company.app.entity/Customer=Customer
com.company.app.entity/Customer.name=Name

com.company.app.entity/OrderStatus=Order status
com.company.app.entity/OrderStatus.NEW=New

customerListView.title=Customers
customerDetailView.title=Customer
createOrderButton.text=Create order

XML Usage

A Jmix message reference has two forms:

• Brief: msg://<key>.
• Full: msg://<message-group>/<key>.

The message group is usually the Java package-style bundle group before / in a properties key. Entity messages often use the entity package group, for example com.company.app.entity/Customer.name. View-local messages usually live in the view package group, for example com.company.app.view.customer/customerListView.title.

Brief references are resolved against the current XML descriptor message group. They are fine for keys stored next to that descriptor:

<view title="msg://customerListView.title">
    <button id="createOrderButton" text="msg://createOrderButton.text"/>
</view>

Use a full reference when the key is in another group, for example entity captions, menu keys, shared application keys, or text used from a descriptor whose package does not match the key group:

<item view="Customer.list" title="msg://com.company.app.view.customer/customerListView.title"/>
<h4 text="msg://com.company.app.entity/Customer.orders"/>

For Bean Validation messages, keep the same full reference inside braces:

@NotNull(message = "{msg://com.company.app.entity/Customer.email.required}")
private String email;

Java Usage In Views

@ViewComponent
private MessageBundle messageBundle;

String text = messageBundle.getMessage("createOrderButton.text");

For localized entity/attribute captions (not bundle-key formatting), inject io.jmix.core.MessageTools and Metadata: messageTools.getEntityCaption(metadata.getClass(Customer.class)) and messageTools.getPropertyCaption(metadata.getClass(Customer.class), "name").

Exact Reference Audit

Before finishing, search changed XML and Java for message references and verify the keys exist in the correct bundle with identical casing.

<button id="createOrderButton" text="msg://createOrderButton.text"/>

createOrderButton.text=Create order

Do not rely on similar casing such as CreateOrderButton.text or createorderButton.text.

Forbidden

• Hardcoded user-visible text in XML or Java controllers.
• Adding a key to only one locale file.
• msg:// keys that differ from properties keys only by case.
• Brief msg://key references to keys stored in another message group.
• Missing enum constant messages.
• ${0} placeholders in formatMessage; use Java formatter placeholders such as %s.