--- og:title: Inlang Message Format Plugin og:description: A storage plugin for inlang that stores messages in JSON files per language. Supports variables, pluralization, and nested structures. ---
---
og:title: Inlang Message Format Plugin
og:description: A storage plugin for inlang that stores messages in JSON files per language. Supports variables, pluralization, and nested structures.
---
The Inlang Message Format is a storage plugin for inlang. It stores messages in a JSON file per language.
It is designed after inlang's data models, which enables all features of inlang.
The syntax is inspired by the upcoming MessageFormat 2.0 draft to keep migration friction low as the standard matures.
The message files contain key-value pairs of the message ID and the translation. You can add variables in your message by using curly braces. To include literal curly braces in your text, escape them with a backslash (\{ and \}). Nested objects are flattened using dot notation on import and unflattened on export.
``json
//messages/en.json
{
"hello_world": "Hello World!",
"greeting": "Good morning {name}!",
"code_example": "Use \\{variable\\} syntax for variables"
}
//messages/de.json
{
"$schema": "https://inlang.com/schema/inlang-message-format",
"hello_world": "Hallo Welt!",
"greeting": "Guten Tag {name}!"
}
`
> [!NOTE]
> The $schema property is optional and provides IDE autocompletion for message syntax. It is automatically added when exporting files and ignored on import. The schema is for editor support only and does not perform runtime validation.
Install the plugin in your Inlang Project by adding it to your "modules" in project.inlang/settings.json. You will also need to provide a pathPattern for the plugin.
`diff`
// project.inlang/settings.json
{
"modules" : [
+ "https://cdn.jsdelivr.net/npm/@inlang/plugin-message-format@latest/dist/index.js"
],
+ "plugin.inlang.messageFormat": {
+ "pathPattern": "./messages/{locale}.json"
+ }
}
| Plugin Version | SDK Requirement | Breaking Changes |
| -------------- | --------------------- | -------------------------------------------------------------------- |
| v4.x | @inlang/sdk v2+ | Complex messages must be wrapped in an array. Nesting support added. |
| v3.x | @inlang/sdk v2 (beta) | Upgraded to SDK v2 data model. |
| v2.x | @inlang/sdk v1 | New human-readable format. Auto-migrates from v1 on first load. |
> [!NOTE]
> When upgrading the plugin, ensure your SDK version meets the minimum requirement. Mismatched versions may cause silent failures or import errors.
Configuration happens in project.inlang/settings.json under the "plugin.inlang.messageFormat" key.
You can define a single pathPattern or provide an array of patterns to split your messages across multiple JSON files. Messages from all matching files will be merged, and if the same message key appears in multiple files, the value from the last file in the array will override earlier ones. The placeholder should be {locale} (preferred) or {languageTag} (legacy, still supported).
This allows for patterns like having a shared base file and extending or overriding it with domain- or customer-specific files.
#### Single path pattern example
`json`
{
"plugin.inlang.messageFormat": {
"pathPattern": "./messages/{locale}.json"
}
}
#### Multiple path patterns example
`json`
{
"plugin.inlang.messageFormat": {
"pathPattern": ["./defaults/{locale}.json", "./clothing/{locale}.json"]
}
}
Given the following files:
`json`
// ./defaults/en.json
{
"hello": "Hello!",
"cart": {
"title": "Your cart"
},
"size": "Size"
}
`json`
// ./clothing/en.json
{
"size": "Clothing size",
"fit": "Fit"
}
The merged result for locale en will be:
`json`
{
"hello": "Hello!",
"cart": {
"title": "Your cart"
},
"size": "Clothing size", // Overridden
"fit": "Fit" // Added
}
This lets you modularize and override translations while keeping a shared base.
> [!WARNING]
> When exporting, all messages are written to the last path pattern in the array. Messages are not split back across multiple files. This means multiple path patterns are a one-way merge — useful for importing from shared base files, but the original file structure is not preserved on export.
Optionally sort keys when writing files to keep git diffs consistent.
`json`
{
"plugin.inlang.messageFormat": {
"pathPattern": "./messages/{locale}.json",
"sort": "asc"
}
}
You can organize your messages in a nested structure for better organization of your translations. There are two types of messages:
> [!NOTE]
> Nesting is supported from v4 of the plugin and requires apps to use the inlang SDK v2 higher.
Simple messages are string values, either directly at the root level or nested within objects:
`json`
{
"hello": "world",
"navigation": {
"home": "Home",
"about": "About",
"contact": {
"email": "Email",
"phone": "Phone"
}
}
}
For complex messages with variants, wrap the message object in an array to differentiate it from nested simple messages:
`json`
{
"simple": "This is a simple message",
"count": [
{
"declarations": ["input count", "local countPlural = count: plural"],
"selectors": ["countPlural"],
"match": {
"countPlural=one": "There is one item",
"countPlural=other": "There are {count} items"
}
}
]
}
When addressing nested messages, use dot notation (e.g. navigation.items.count for a nested navigation.items.count entry).
> [!NOTE]
> The array wrapper is how we distinguish between a nested object containing more messages vs. a complex message object with variants.
Since curly braces { and } are used to denote variables, you need to escape them if you want to include literal braces in your message text. Use a backslash to escape:
- \{ → literal {
- → literal }
- → literal \
This is useful when your translations contain code snippets, JSON examples, or other text with curly braces:
`json`
{
"json_hint": "JSON objects look like \\{\"key\": \"value\"\\}",
"template_help": "Use \\{variable\\} to insert dynamic values",
"path_example": "Windows paths use \\\\ as separator"
}
The above messages will render as:
- JSON objects look like {"key": "value"}
-
-
> [!NOTE]
> Escaping is only necessary for {, }, and \ characters. Other special characters can be used directly.
The message below will match the following conditions:
| Platform | User Gender | Message |
| -------- | ----------- | --------------------------------------------------------------------------- |
| android | male | {username} has to download the app on his phone from the Google Play Store. |
| ios | female | {username} has to download the app on her iPhone from the App Store. |
| \ | \ | The person has to download the app. |
`json`
{
"jojo_mountain_day": [
{
"match": {
"platform=android, userGender=male": "{username} has to download the app on his phone from the Google Play Store.",
"platform=ios, userGender=female": "{username} has to download the app on her iPhone from the App Store.",
"platform=, userGender=": "The person has to download the app."
}
}
]
}
#### Ordinal pluralization (1st, 2nd, 3rd…)
plural forwards its options to Intl.PluralRules, so you can request ordinal categories by passing type=ordinal in your declaration.
`json`
{
"finished_readout": [
{
"declarations": [
"input placeNumber",
"local ordinalCategory = placeNumber: plural type=ordinal"
],
"selectors": ["ordinalCategory"],
"match": {
"ordinalCategory=one": "You finished in {placeNumber}st place",
"ordinalCategory=two": "You finished in {placeNumber}nd place",
"ordinalCategory=few": "You finished in {placeNumber}rd place",
"ordinalCategory=*": "You finished in {placeNumber}th place"
}
}
]
}
> [!TIP]
> Ordinal category names (one, two, few, other, etc.) follow Intl.PluralRules for the active locale.
Pluralization is also supported. You can define a variable in your message and then use it in the selector.
| Inputs | Condition | Message |
| ------- | ----------------- | -------------------- |
| count=1 | countPlural=one | There is one cat. |
| count>1 | countPlural=other | There are many cats. |
> [!TIP]
> Read the local countPlural = count: plural syntax as "create a local variable countPlural that equals plural(count)".
`json`
{
"some_happy_cat": [
{
"declarations": ["input count", "local countPlural = count: plural"],
"selectors": ["countPlural"],
"match": {
"countPlural=one": "There is one cat.",
"countPlural=other": "There are many cats."
}
}
]
}
- File not found: Missing translation files are silently ignored. Verify that your pathPattern matches the actual file paths and that the {locale} placeholder resolves correctly.locales
- Wrong locale: Ensure the locale in the filename matches one of the configured in your settings.json.
- Trailing commas: JSON does not allow trailing commas. Remove the comma after the last property in objects and arrays.
- Comments: Standard JSON does not support comments. The examples in this README use // comments for illustration only — remove them in actual files.
Each message can only have one variant per locale within a single match condition set. If you need multiple variants, use selectors to differentiate them:
`json`
{
"message": [
{
"selectors": ["platform"],
"match": {
"platform=ios": "iOS version",
"platform=android": "Android version"
}
}
]
}
- Nesting requires plugin v4+ and SDK v2+. Check the Version Compatibility table.
- Maximum nesting depth is 5 levels. Flatten deeper structures using dot notation in the key name.
Complex messages (with variants/pluralization) must be wrapped in an array:
`json``
{
"wrong": { "match": { "count=one": "One" } },
"correct": [{ "match": { "count=one": "One" } }]
}