tirendus
commented
6 months ago I've made something similar and wanted to propose it to be added to this repo, but couldn't find the time for a proper PR.
The high level overview is:
You have a watcher assigned to your localization file. Whenever the file changes it triggers a dart script that generates locale strings in a convenient format inside your project. Basically it turns your json into a set of classes and json keys into its properties. The code autocompletes so there's no need to write raw strings hence there's no human error possible. Also the scripts executes instantly on file change, so there's no need to run the code generation tool after every edit. There's a keyPath property assigned to every key for pluralization support.
Example localization file en.json
{
"example": {
"title": "This is a title",
"numberOfExamples": {
"one": "{} example",
"two": "{} examples",
"few": "{} examples",
"other": "{} examples"
},
"map": {
"title": "Map title",
"mapInsideMap": {
"title": "Map inside map title"
}
}
}
}Example output file locale_keys.g.dart
abstract class Loc {
static var example = _ExampleKeys();
}
class _ExampleKeys {
String title = "example.title";
var numberOfExamples = _ExampleNumberOfExamplesKeys();
var map = _ExampleMapKeys();
String get keyPath => 'example';
}
class _ExampleNumberOfExamplesKeys {
String one = "example.numberOfExamples.one";
String two = "example.numberOfExamples.two";
String few = "example.numberOfExamples.few";
String other = "example.numberOfExamples.other";
String get keyPath => 'example.numberOfExamples';
}
class _ExampleMapKeys {
String title = "example.map.title";
var mapInsideMap = _ExampleMapMapInsideMapKeys();
String get keyPath => 'example.map';
}
class _ExampleMapMapInsideMapKeys {
String title = "example.map.mapInsideMap.title";
String get keyPath => 'example.map.mapInsideMap';
}Example usage.
import '../../../generated/locale_keys.g.dart';
Text(Loc.example.title.tr());
Text(Loc.example.map.title.tr());
Text(Loc.example.map.mapInsideMap.title.tr());
Text(plural(Loc.example.numberOfExamples.keyPath, 5));To use this. 1) Add watcher to your dev_dependencies in pubspec.yaml
dev_dependencies:
watcher: ^1.1.02) Create loc_generate.dart in the root of your project (same depth as pubspec.yaml is at). Copy the following into it. Change translationAssetPath to the path of one of your translation files that you are going to be updating first.
import 'dart:convert';
import 'dart:io';
import 'package:watcher/watcher.dart';
String capitalize(String s) => s[0].toUpperCase() + s.substring(1);
const translationAssetPath = 'assets/translations/en.json';
void generateProperties(
StringBuffer buffer,
Map<String, dynamic> jsonData,
List<String> paths,
int depth,
) {
List<String> classes = [];
var prefix = depth > 1 ? '${paths.join('.')}.' : '';
for (var key in jsonData.keys) {
var value = jsonData[key]!;
if (value is Map) {
classes.add(key);
String className =
'_${[...paths, key].map((e) => capitalize(e)).join()}Keys';
if (depth == 1) {
buffer.writeln(' static var $key = $className();');
} else {
buffer.writeln(' var $key = $className();');
}
} else {
if (depth == 1) {
buffer.writeln(' static const String $key = "$prefix$key";');
} else {
buffer.writeln(' String $key = "$prefix$key";');
}
}
}
if (prefix.isNotEmpty) {
buffer.writeln(
' String get keyPath => \'${prefix.substring(0, prefix.length - 1)}\';');
}
buffer.writeln('}');
buffer.writeln('');
for (var key in classes) {
var newPaths = [...paths, key];
String className =
'_${[...paths, key].map((e) => capitalize(e)).join()}Keys';
buffer.writeln('class $className {');
generateProperties(buffer, jsonData[key], newPaths, depth + 1);
}
}
void generate() {
final File jsonFile = File(translationAssetPath);
final String jsonString = jsonFile.readAsStringSync();
final Map<String, dynamic> jsonData = json.decode(jsonString);
final StringBuffer buffer = StringBuffer();
buffer.write(
'export \'package:easy_localization/easy_localization.dart\';\n\n',
);
buffer.writeln('abstract class Loc {');
generateProperties(buffer, jsonData, [], 1);
final generatedDirectory = Directory('lib/generated');
if (!generatedDirectory.existsSync()) {
generatedDirectory.createSync(recursive: true);
}
const outputFilePath = 'lib/generated/locale_keys.g.dart';
File(outputFilePath).writeAsStringSync(buffer.toString());
}
void main() {
final watcher = FileWatcher(translationAssetPath);
watcher.events.listen((event) {
if (event.type == ChangeType.MODIFY) {
// ignore: avoid_print
print('File changed: ${event.path}');
try {
generate();
} catch (e) {
// ignore: avoid_print
print('aborting $e');
}
}
});
}
3) Open a separate terminal window and start the script.
dart loc_generate.dart
In conclusion. This approach is very convenient but has a few issues.
- It only creates keys based on one file, so keys between your localization files must be synchronized
- Currently the localization file path is hardcoded into the script
- It has a dependency on watcher, but I really think it's no big deal
hasimyerlikaya
Hi,
I use locale keys generator and I have an idea. I think we can use records to generate keys.
I group my keys in the language file.
This is the generated locale keys. I think these key names are ugly and difficult to read and write.
As you can see, the record format is much more readable. It might affect the file size too.
When we want to use the keys, we can see the list much better.
Maybe it can be optional. If you can add this support, I think it will be very useful for developers like me.