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.
The path pattern defines where the plugin will be looking for your message files. The default is ./messages/{locale}.json. The {locale} placeholder will be replaced with the language tag for each of your languages.
You can also define an array of paths. The last path in the array will take precedence over the previous ones. This is useful if you want to have a default message file that is overridden by a customer-specific file.
For complex messages with variants, wrap the message object in an array to differentiate it from nested simple messages:
{"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 accessing this complex message, use dot notation: navigation.items.count
The array wrapper is how we distinguish between a nested object containing more messages vs. a complex message object with variants.
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.
{"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."}}]}
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.
Read the `local countPlural = count: plural` syntax as "create a local variable `countPlural` that equals `plural(count)`".
{"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."}}]}