feat: add "base_locale_empty_string" config

slang-i18n · Dec 21, 2023 · db54b4b · db54b4b
1 parent 20c738a
commit db54b4b
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 12 deletions.
diff --git a/slang/lib/builder/builder/generate_config_builder.dart b/slang/lib/builder/builder/generate_config_builder.dart
@@ -1,5 +1,6 @@
 import 'package:slang/builder/builder/build_model_config_builder.dart';
 import 'package:slang/builder/model/context_type.dart';
+import 'package:slang/builder/model/enums.dart';
 import 'package:slang/builder/model/raw_config.dart';
 import 'package:slang/builder/model/generate_config.dart';
 import 'package:slang/builder/model/interface.dart';
@@ -17,7 +18,7 @@ class GenerateConfigBuilder {
       inputDirectoryHint: inputDirectoryHint,
       baseName: baseName,
       baseLocale: config.baseLocale,
-      fallbackStrategy: config.fallbackStrategy,
+      fallbackStrategy: config.fallbackStrategy.toGenerateFallbackStrategy(),
       outputFormat: config.outputFormat,
       localeHandling: config.localeHandling,
       flutterIntegration: config.flutterIntegration,

diff --git a/slang/lib/builder/builder/translation_model_builder.dart b/slang/lib/builder/builder/translation_model_builder.dart
@@ -230,6 +230,13 @@ Map<String, Node> _parseMapNode({
     if (value is String || value is num) {
       // leaf
       // key: 'value'
+
+      if (config.fallbackStrategy == FallbackStrategy.baseLocaleEmptyString &&
+          value is String &&
+          value.isEmpty) {
+        return;
+      }
+
       final textNode = modifiers.containsKey(NodeModifiers.rich)
           ? RichTextNode(
               path: currPath,
@@ -315,6 +322,7 @@ Map<String, Node> _parseMapNode({
               case FallbackStrategy.none:
                 throw '"$currPath" in <$localeDebug> is empty but it is marked for pluralization / context. Define "fallback_strategy: base_locale" to ignore this node.';
               case FallbackStrategy.baseLocale:
+              case FallbackStrategy.baseLocaleEmptyString:
                 return;
             }
           }

diff --git a/slang/lib/builder/generator/generate_translations.dart b/slang/lib/builder/generator/generate_translations.dart
@@ -119,7 +119,7 @@ void _generateClass(
             parentName: className,
             locale: config.baseLocale,
           );
-    if (config.fallbackStrategy == FallbackStrategy.none) {
+    if (config.fallbackStrategy == GenerateFallbackStrategy.none) {
       buffer.writeln(
           'class $finalClassName$mixinStr implements $baseClassName {');
     } else {
@@ -129,7 +129,7 @@ void _generateClass(
 
   // constructor and custom fields
   final callSuperConstructor = !localeData.base &&
-      config.fallbackStrategy == FallbackStrategy.baseLocale;
+      config.fallbackStrategy == GenerateFallbackStrategy.baseLocale;
   if (root) {
     if (localeData.base && config.flutterIntegration && config.localeHandling) {
       buffer.writeln(
@@ -218,7 +218,7 @@ void _generateClass(
       buffer.write(
           'dynamic operator[](String key) => \$meta.getTranslation(key)');
 
-      if (config.fallbackStrategy == FallbackStrategy.baseLocale &&
+      if (config.fallbackStrategy == GenerateFallbackStrategy.baseLocale &&
           !localeData.base) {
         buffer.writeln(' ?? super.\$meta.getTranslation(key);');
       } else {
@@ -277,12 +277,13 @@ void _generateClass(
     // even if this attribute exist, it has to satisfy the same signature as
     // specified in the interface
     // this error seems to occur when using in combination with "extends"
-    final optional = config.fallbackStrategy == FallbackStrategy.baseLocale &&
-            node.interface?.attributes.any((attribute) =>
-                    attribute.optional && attribute.attributeName == key) ==
-                true
-        ? '?'
-        : '';
+    final optional =
+        config.fallbackStrategy == GenerateFallbackStrategy.baseLocale &&
+                node.interface?.attributes.any((attribute) =>
+                        attribute.optional && attribute.attributeName == key) ==
+                    true
+            ? '?'
+            : '';
 
     if (value is StringTextNode) {
       final translationOverrides = config.translationOverrides

diff --git a/slang/lib/builder/model/enums.dart b/slang/lib/builder/model/enums.dart
@@ -1,6 +1,10 @@
 enum FileType { json, yaml, csv, arb }
 
-enum FallbackStrategy { none, baseLocale }
+enum FallbackStrategy { none, baseLocale, baseLocaleEmptyString }
+
+/// Similar to [FallbackStrategy] but [FallbackStrategy.baseLocaleEmptyString]
+/// has been already handled in the previous step.
+enum GenerateFallbackStrategy { none, baseLocale }
 
 enum OutputFormat { singleFile, multipleFiles }
 
@@ -19,6 +23,8 @@ extension Parser on String {
         return FallbackStrategy.none;
       case 'base_locale':
         return FallbackStrategy.baseLocale;
+      case 'base_locale_empty_string':
+        return FallbackStrategy.baseLocaleEmptyString;
       default:
         return null;
     }
@@ -85,3 +91,16 @@ extension Parser on String {
     }
   }
 }
+
+extension FallbackStrategyExt on FallbackStrategy {
+  GenerateFallbackStrategy toGenerateFallbackStrategy() {
+    switch (this) {
+      case FallbackStrategy.none:
+        return GenerateFallbackStrategy.none;
+      case FallbackStrategy.baseLocale:
+        return GenerateFallbackStrategy.baseLocale;
+      case FallbackStrategy.baseLocaleEmptyString:
+        return GenerateFallbackStrategy.baseLocale;
+    }
+  }
+}
diff --git a/slang/lib/builder/model/generate_config.dart b/slang/lib/builder/model/generate_config.dart
@@ -12,7 +12,7 @@ class GenerateConfig {
   final String inputDirectoryHint; // for comment
   final String baseName; // name of all i18n files, like strings or messages
   final I18nLocale baseLocale; // defaults to 'en'
-  final FallbackStrategy fallbackStrategy;
+  final GenerateFallbackStrategy fallbackStrategy;
   final OutputFormat outputFormat;
   final bool localeHandling;
   final bool flutterIntegration;