arb_utils

Description:

arb utils

arb_utils #
Common actions to perform over .arb formatted strings
Usage #
A simple usage example:
import 'package:arb_utils/arb_utils.dart';

main() {
print('Generating .arb for translators...');
var chkout = 'latestTranslationsProcessedBranch'; // or a49630b726c or HEAD^3 etc
Process.runSync('git', 'checkout $chkout'.split(' '));
var mainARBOld = File('lib/l10n/intl_en.arb').readAsStringSync();
Process.runSync('git', 'checkout master'.split(' '));
var mainARBNew = File('lib/l10n/intl_en.arb').readAsStringSync();
File('lib/l10n/new_translations/intl_en.arb')
.writeAsStringSync(sortARB(processNewKeys(mainARBNew, mainARBOld)));
print('lib/l10n/new_translations/intl_en.arb generated');
}
copied to clipboard
Features #
Manual language switching helpers #
Normally there's the need of providing a way of manually changing the locale on runtime. Here is a super easy way of doing so depending on the state manager you use:

The solution handles the persistance of the user selection for app restarts and so.
Provider/BLoC
Given that BLoC relies on Provider for working this solution will work easily for both state managers:
//make sure this line is written, your IDE may not add it automatically
import 'package:provider/provider.dart';
import 'package:arb_utils/state_managers/l10n_provider.dart';

//prefix your MaterialApp(//... with the following:
ChangeNotifierProvider(
create: (_) => ProviderL10n(),
child: Builder(builder: (context) {
return MaterialApp(
locale: context.watch<ProviderL10n>().locale,
supportedLocales: AppLocalizations.supportedLocales,

//now add this widget wherever you want:
import 'package:arb_utils/arb_utils_flutter.dart';

LanguageSelectorDropdown(
supportedLocales: AppLocalizations.supportedLocales,
provider: context.read<ProviderL10n>(),
)
copied to clipboard
MobX/GetX/GetIt/Riverpod/Binder/Redux/etc
Pull Requests are always welcome :-D!
ArbClient #
A way of getting your ARB translations dynamically, not hardcoded like S.of(context).key / AppLocalizations.of(context).key. It has been made with the pretension of supporting a way of getting the .arb files from the backend, on demand, but if it suits your use case, it just works. (PR are always welcome)
var arbClient = ArbClient(englishArbString, locale: 'en', onMissingKey: (key) => print('ARB key not found: $key'), exceptionOnMissingKey: kDebugMode, onMissingKeyValue: (key) => 'value of $key');
print(arbClient['hellowWorld']); // Hello World!
arbClient.reloadJson(json.decode(spanishArbString));
print(arbClient['hellowWorld']); // ¡Hola Mundo!
print(arbClient.get('helloName',{'name':'Nico'})); // ¡Hola Nico!
copied to clipboard
Standalone functions #
sortARB
alters the order of every .arb key alphabetically, putting their @key metadata below every one
{
"@aKey":{
"description":"simple description"
},
"zKey":"a simple key",
"@zKey":{
"description":"simple description"
},
"aKey":"a simple key",
}
copied to clipboard
will be converted to:
{
"aKey":"a simple key",
"@aKey":{
"description":"simple description"
},
"zKey":"a simple key",
"@zKey":{
"description":"simple description"
}
}
copied to clipboard
You can also provide a custom sort function.
var arb1 = '''
{
"clave":"valor",
"@clave":{
"description": "Descripcion"
},
"key":"value",
"@key":{
"description": "Description"
}
}''';
var sortedArb1 = sortARB(arb1, (a, b) => a[1].compareTo(b[1]));
print(sortedArb1);
/*
{
"key":"value",
"@key":{
"description": "Description"
},
"clave":"valor",
"@clave":{
"description": "Descripcion"
}
}
*/
copied to clipboard
Know that the most common sortings are implemented out of the box with the following parameters
var sorted = sortARB(arbString, caseInsensitive: false, naturalOrdering: false, descendingOrdering: false);
copied to clipboard
diffARBs
Will generate a .arb formatted string with the keys that doesn't appear in both the provided .arb formatted arguments
var arb1 = '''
{
"clave":"valor",
"@clave":{
"description": "Descripcion"
},
"key":"value",
"@key":{
"description": "Description"
}
}''';
var arb2 = '''
{
"clave":"valor",
"@clave":{
"description": "Descripcion"
},
"newKey":"new value",
"@newKey":{
"description": "new Description"
}
}''';
var diffed = diffARBs(arb1, arb2);
print(diffed);
/*
{
"key":"value",
"@key":{
"description": "Description"
},
"newKey":"new value",
"@newKey":{
"description": "new Description"
}
}
*/
copied to clipboard
mergeARBs
Will include the latter .arb keys in the former one and output a .arb formatted string with the merged keys, privileging the latter ones
var former = '''{
"aKey":"a simple key",
"@aKey":{
"description":"simple description"
},
"bKey":"a simple key",
"@bKey":{
"description":"simple description"
},
"zKey":"a simple key",
"@zKey":{
"description":"simple description"
}
''';
var latter = '''{
"aKey":"a MODIFIED simple key",
"@aKey":{
"description":"simple description"
},
"cKey":"a simple key",
"@cKey":{
"description":"simple description"
},
"zKey":"a simple key",
"@zKey":{
"description":"simple description"
}
}''';
var merged = mergeARBs(former,latter);
print(merged);
/*
{
"aKey":"a MODIFIED simple key",
"@aKey":{
"description":"simple description"
},
"bKey":"a simple key",
"@bKey":{
"description":"simple description"
},
"cKey":"a simple key",
"@cKey":{
"description":"simple description"
},
"zKey":"a simple key",
"@zKey":{
"description":"simple description"
}
}
*/
copied to clipboard
processNewKeys
Compares an .arb formatted string with a previous version of itself and outputs a new .arb formatted string with the new keys found there (also the edited ones)
var oldVersion = '''{
"aKey":"a simple key",
"@aKey":{
"description":"simple description"
},
"bKey":"a simple key",
"@bKey":{
"description":"simple description"
},
"cKey":"a simple key",
"@cKey":{
"description":"simple description"
},
"zKey":"a simple key",
"@zKey":{
"description":"simple description"
}
}''';
var newVersion = '''{
"aKey":"a MODIFIED simple key",
"@aKey":{
"description":"simple description"
},
"bKey":"a simple key",
"@bKey":{
"description":"simple description"
},
"cKey":"a simple key",
"@cKey":{
"description":"simple description"
},
"zKey":"a simple key",
"@zKey":{
"description":"A MORE ROBUST description"
}
}''';
var newARB = processNewKeys(newVersion, oldVersion);
print(newARB);
/*
{
"aKey":"a MODIFIED simple key",
"@aKey":{
"description":"simple description"
},
"zKey":"a simple key",
"@zKey":{
"description":"A MORE ROBUST description"
}
}
*/
copied to clipboard
Bin scripts #
Please run
dart pub global activate arb_utils
copied to clipboard
to enable arb_utils as an executable command on your system.
Sort
To easily sort an arb and update original file, use
arb_utils sort <INPUT FILE>
copied to clipboard
where <INPUT FILE> is a path to the input file.
Also, there are 3 flags for different sorting.

--case-insensitive / -i
--natural-ordering / -n
--descending / -d

For example, to sort with case insensitive and in descending order, use
arb_utils sort -i -d <INPUT FILE>
copied to clipboard
Add Missing Default Metadata
To easily add missing metadata to an arb and update original file, use
arb_utils generate-meta <INPUT FILE>
copied to clipboard
where <INPUT FILE> is a path to the input file.
Reference #
Check this article for understanding more about i18n with .arb in Flutter: https://phrase.com/blog/posts/flutter-localization/