l10n_mapper_generator 1.3.0 l10n_mapper_generator: ^1.3.0 copied to clipboard
A dart package to generate localization-mapper to support parsing dynamic translation keys (as flutter-localizations package does not yet support this).
l10n_mapper_annotation #
A dart package to support parsing dynamic translation keys (as flutter-localizations package does not yet support this).
Note: Setup localization using flutter_localizations
package before proceeding with this.
Getting started
Install dependencies
dependencies:
flutter:
sdk: flutter
flutter_localizations:
sdk: flutter
l10n_mapper_annotation: <latest-version>
dev_dependencies:
build_runner: ^2.3.3
l10n_mapper_generator: <latest-version>
To run l10n_mapper_generator
in terminal, you should activate/install it as a global dependency
dart pub global activate l10n_mapper_generator
Mapper (--gen-mapper)
This generator flag indicates annotating the specified app_localizations.dart
class on which utility methods will be generated for dynamic localization-keys access by the generator.
To generate app-localization mapper that can be parsed dynamic translation keys, you should simply
- run
flutter gen-l10n
to generateapp_localizations.dart
file with localization related files - create
l10n_mapper.json
configuration file in your project`s root directory with the following options
// l10n_mapper.json
{
"generatorOptions": {
"l10n": true, // optional [default value - true]
"locale": true, // optional [default value - true]
"l10nParser": true, // optional [default value - true]
"appLocalizations": "lib/localization/gen-l10n/app_localizations.dart",
"translation": {
"nullable": false, // [default value - true. When false, message should be provided]
"message": "Cannot find translation-key!" // optional [default value - null. When `nullable: false`, message should be provided]
}
}
}
- l10n: boolean-value with default as true - required to generate `l10n` extension method
- locale: boolean-value with default as true - required to generate `locale` extension method
- l10nParser: boolean-value with default as true - required to generate `l10nParser` extension method
- appLocalizations: location of your generated `app_localizations.dart` file after running `flutter gen-l10n`
- nullable: indicates if generated `l10nParser` should be nullable or not. If value is false, provide a `message` value to return when translation-key is not found.
- message: A fallback message to return when translation-key is not found. This should only be provided when `nullable: false`.
- run the following scripts in succession (after setting-up
l10n_mapper.json
configuration file)
# Annotate `app_localizations` to generate `app_localizations.g.dart` file
dart pub run l10n_mapper_generator --gen-mapper
# Generate required code (this should generate `app_localizations.g.dart` [part file for `app_localizations.dart`] consisting of `AppLocalizationsExtension` and `AppLocalizationsMapper` classes)
flutter pub run build_runner build --delete-conflicting-outputs
Format (--format)
This generator flag indicates formatting translation-file keys to match dart naming convention for translations to generate dart translation related files. A simple usecase for this is utilizing the same translation files originally defined for other frameworks
Example
<!-- en-English.arb -->
<!-- this was originally defined with compatible naming convention for a typescript/javascript project -->
"test.send_your_USDT(TRON)_withdraw": "Send your USDT (TRC-20) withdrawal to:",
"@test.send_your_USDT(TRON)_withdraw": {
"type": "text"
},
Originally, the above example was defined for typescript/javascript support. Using --format
flag formats these keys to support dart-naming convention which is compatible for dart to generate localization related files without errors when running flutter gen-l10n
.
To format translation-files, you can simply
- setup
l10n_mapper.json
configuration file in your project`s root directory with the following options
// l10n_mapper.json
{
"formatterOptions": {
"prefix": "app", // file-name prefix to apply when creating translation-file after formatting
"inputPath": "lib/localization/translations/remote", // directory containing translation-files that require formatting
"outputPath": "lib/localization/translations/local", // directory where translation files will be create-in after formatting
"translations": [
{
"locale": "ar", // locale of translation after formatting
"input": "ar-Arabic.arb", // translation requiring formatting
"output": "ar.arb" // translation name after formatting eg. app_ar.arb (appended prefix after formatting)
},
{
"locale": "de",
"input": "de-German.arb",
"output": "de.arb"
},
{
"locale": "en",
"input": "en-English.arb",
"output": "en.arb"
}
],
"keyPredicateMatch": { // contains all predicates to match and replace eg. `.` will be replace with `_` when found in a key
"-": "_",
".": "_",
"^": "_",
"(": "_",
")": "_"
}
},
}
- run
flutter gen-l10n
to generateapp_localizations.dart
file with localization related files - run
flutter pub run build_runner build
command to generate the formatted files and other generator files as well
NOTE: Given the above configuration setup of l10n_mapper.json
, the generated translation file for the above example will be
<!-- app_en.arb -->
<!--
this is now compatible with dart naming convention with
- uppercase characters converted to lowercase
- all `.`, `(` and `)` converted to `_`
-->
"test_send_your_usdt_tron_withdraw": "Send your USDT (TRC-20) withdrawal to:",
"@test_send_your_usdt_tron_withdraw": {
"type": "text"
},
Here is a complete structure of the l10n_mapper.json
file
{
"formatterOptions": {
"prefix": "app",
"inputPath": "lib/localization/translations/remote",
"outputPath": "lib/localization/translations/local",
"translations": [
{
"locale": "ar",
"input": "ar-Arabic.arb",
"output": "ar.arb"
},
{
"locale": "de",
"input": "de-German.arb",
"output": "de.arb"
},
{
"locale": "en",
"input": "en-English.arb",
"output": "en.arb"
}
],
"keyPredicateMatch": {
"-": "_",
".": "_",
"^": "_",
"(": "_",
")": "_"
}
},
"generatorOptions": {
"l10n": true, // optional [default value - true]
"locale": true, // optional [default value - true]
"l10nParser": true, // optional [default value - true]
"appLocalizations": "lib/localization/gen-l10n/app_localizations.dart",
"translation": {
"nullable": false, // [default value - true. When false, message should be provided]
"message": "Cannot find translation-key!" // optional [default value - null. When `nullable: false`, message should be provided]
}
}
}
Note: For convenience and a cleaner reuseable approach, you can create a shell script (in the projects root directory) to collectively run the above scripts in succession.
You should setup l10n_mapper.json
configuration file before running dart pub run l10n_mapper_generator
command
./generate_localization.sh
#!/bin/bash
# format translation-files in `translations/remote` to dart compatible format
dart pub run l10n_mapper_generator --format
# generate localization-related files
flutter gen-l10n
# annotate `app_localizations` to generate `app_localizations.g.dart` file
dart pub run l10n_mapper_generator --gen-mapper
# Generate required code (this should generate `app_localizations.g.dart` [part file for `app_localizations.dart`] consisting of `AppLocalizationsExtension` and `AppLocalizationsMapper` classes)
flutter pub run build_runner build --delete-conflicting-outputs
To run this, you can simply run the following in your terminal (project root-directory)
- make
./generate_localization.sh
executable by runningchmod +x ./generate_localization.sh
- run script by running
./generate_localization.sh
.
Note: You can parse the directory path to find l10n_mapper.json
if it is not defined in the projects' root directory (default expected location) when running dart pub run l10n_mapper_generator
command.
# provide path to directory where `l10n_mapper.json` is defined
dart pub run l10n_mapper_generator --config=lib/config # directory contains `l10n_mapper.json` configuration file
Helper extensions
To access translations dynamically and parse placeholder parameters, a part file of app-localizations.dart
is generated consisting of an access extension on build-context and a mapper.
// ../app-localizations.g.dart
// GENERATED CODE - DO NOT MODIFY BY HAND
part of 'app_localizations.dart';
// **************************************************************************
// L10nMapperGenerator
// **************************************************************************
extension AppLocalizationsExtension on BuildContext {
AppLocalizations get l10n => AppLocalizations.of(this)!;
Locale get locale => Localizations.localeOf(this);
String l10nParser(String translationKey, {List<Object>? arguments}) {
const mapper = AppLocalizationsMapper();
final object = mapper.toLocalizationMap(this)[translationKey];
if (object == null) return 'Cannot find translation-key!';
if (object is String) return object;
assert(arguments != null, 'Arguments should not be null!');
assert(arguments!.isNotEmpty, 'Arguments should not be empty!');
return Function.apply(object, arguments);
}
}
class AppLocalizationsMapper {
const AppLocalizationsMapper();
Map<String, dynamic> toLocalizationMap(BuildContext context) {
return {
'localeName': AppLocalizations.of(context)!.localeName,
'application_name': AppLocalizations.of(context)!.application_name,
'deposit_timeframe': AppLocalizations.of(context)!.deposit_timeframe,
'balance_reverted': (currency) =>
AppLocalizations.of(context)!.balance_reverted(currency),
'convert_before_withdraw': (convertFrom, convertTo) =>
AppLocalizations.of(context)!
.convert_before_withdraw(convertFrom, convertTo),
'convert_before_withdraw_again': (convertFrom, convertTo) =>
AppLocalizations.of(context)!
.convert_before_withdraw_again(convertFrom, convertTo),
};
}
}
Configuring generator
Configurations can be parsed through the L10MapperAnnotation
to specify what extension methods to generate. This is applicable when your application already defined relative extension methods so it is ideal to disable the generation of these already defined extension methods. Below, are config options available
import 'package:l10n_mapper_annotation/l10n_mapper_annotation.dart';
part 'app_localizations.g.dart';
@L10nMapperAnnotation(
mapperExtension:
L10nMapperExtension(l10n: true, locale: true, l10nParser: true),
translationConfig: TranslationConfig(
nullable: false, message: 'Cannot find translation-key!'),
)
Note: This is the default config defined. To change this default configuration, you can specify different options in l10n_mapper.json
configuration file.
Example usage
Note: parameters, are parsed as a list of positional arguments which should be in the same order as specified in the translation key-value pair.
final applicationName = context.l10nParser('application_name'); // Localization mapper
final depositTimeFrame = context.l10nParser('deposit_timeframe'); // Instant
// parsing placeholder parameters
final convertBeforeWithdraw = context.l10nParser('convert_before_withdraw', arguments: ['CAD', 'EUR']); // * For withdrawing your CAD you first need to convert it back to EUR
Resources
Here is a proposal this package is aimed to resolve
Note: Your PRs regarding this is highly encouraged and welcome
For more information, checkout the example project.