Merge pull request #22 from ipcjs/dev/gen-l10n

Use `flutter gen-l10n` to generate `FormBuilderLocalizations`

Author: deandreamatias

README.md

@@ -103,7 +103,7 @@ And you can still add your custom error messages.
 
 ### Setup
 
-To allow for localization of default error messages within your app, add `FormBuilderLocalizations.delegate` in the list of your app's `localizationsDelegates`
+The default error message is in English. To allow for localization of default error messages within your app, add `FormBuilderLocalizations.delegate` in the list of your app's `localizationsDelegates`
 
 ```dart
   return MaterialApp(
@@ -171,6 +171,10 @@ TextFormField(
 ),
 ```
 
+#### Modify the default error message in a specific language
+
+see [override_form_builder_localizations_en](example/lib/override_form_builder_localizations_en.dart) for more detail.
+
 ## Support
 
 ### Contribute
@@ -193,13 +197,13 @@ Create one ARB file inside the `lib/l10n` folder for each of the locales you nee
 
 2. Translate the error messages
 
-Duplicate the contents of `intl_messages.arb` (or any other ARB file) into your newly created ARB file, then translate the error messages by overwriting the default messages.
+Duplicate the contents of `intl_en.arb` (or any other ARB file) into your newly created ARB file, then translate the error messages by overwriting the default messages.
 
 3. Generate localization code
 
 To generate boilerplate code for localization, run the generate command inside the package directory where `pubspec.yaml` file is located:
 
-`flutter pub run intl_utils:generate`
+`flutter gen-l10n`
 
 Running the command will automatically create/update files inside the `lib/localization` directory, including your newly added locale support.
 

analysis_options.yaml

@@ -2,4 +2,3 @@ include: package:flutter_lints/flutter.yaml
 
 analyzer:
   exclude:
-    - lib/localization/intl/**

example/lib/main.dart

@@ -1,3 +1,4 @@
+import 'package:example/override_form_builder_localizations_en.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_localizations/flutter_localizations.dart';
 import 'package:form_builder_validators/form_builder_validators.dart';
@@ -17,9 +18,13 @@ class MyApp extends StatelessWidget {
       title: 'Form Builder Validators Demo',
       theme: ThemeData(primarySwatch: Colors.blue),
       home: const HomePage(),
-      supportedLocales: [...FormBuilderLocalizations.delegate.supportedLocales],
+      supportedLocales: const [
+        ...FormBuilderLocalizations.supportedLocales,
+      ],
       localizationsDelegates: const [
         ...GlobalMaterialLocalizations.delegates,
+        // Placed in front of `FormBuilderLocalizations.delegate`
+        OverrideFormBuilderLocalizationsEn.delegate,
         FormBuilderLocalizations.delegate,
       ],
     );

example/lib/override_form_builder_localizations_en.dart

@@ -0,0 +1,38 @@
+import 'package:flutter/foundation.dart';
+import 'package:flutter/material.dart';
+import 'package:form_builder_validators/form_builder_validators.dart';
+
+/// Created by ipcjs on 2022/10/31.
+class OverrideFormBuilderLocalizationsEn
+    extends FormBuilderLocalizationsImplEn {
+  OverrideFormBuilderLocalizationsEn();
+
+  static const LocalizationsDelegate<FormBuilderLocalizationsImpl> delegate =
+      _LocalizationsDelegate();
+
+  static const List<Locale> supportedLocales = [Locale('en')];
+
+  // Override a field and return your translation.
+  @override
+  String get requiredErrorText => 'override: This field cannot be empty.';
+}
+
+class _LocalizationsDelegate
+    extends LocalizationsDelegate<FormBuilderLocalizationsImpl> {
+  const _LocalizationsDelegate();
+
+  @override
+  Future<FormBuilderLocalizationsImpl> load(Locale locale) {
+    final instance = OverrideFormBuilderLocalizationsEn();
+    // IMPORTANT!! must to invoke setCurrentInstance()
+    FormBuilderLocalizations.setCurrentInstance(instance);
+    return SynchronousFuture<FormBuilderLocalizationsImpl>(instance);
+  }
+
+  @override
+  bool isSupported(Locale locale) =>
+      OverrideFormBuilderLocalizationsEn.supportedLocales.contains(locale);
+
+  @override
+  bool shouldReload(_LocalizationsDelegate old) => false;
+}

example/pubspec.lock

@@ -125,7 +125,7 @@ packages:
       name: source_span
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.9.1"
+    version: "1.9.0"
   stack_trace:
     dependency: transitive
     description:

l10n.yaml

@@ -0,0 +1,7 @@
+# https://docs.flutter.dev/development/accessibility-and-localization/internationalization#adding-your-own-localized-messages
+arb-dir: lib/l10n
+template-arb-file: intl_en.arb
+synthetic-package: false
+output-dir: lib/localization/intl
+output-localization-file: messages.dart
+output-class: FormBuilderLocalizationsImpl

lib/form_builder_validators.dart

@@ -1,4 +1,36 @@
 library form_builder_validators;
 
+export 'localization/intl/messages.dart';
+export 'localization/intl/messages_ar.dart';
+export 'localization/intl/messages_bn.dart';
+export 'localization/intl/messages_bs.dart';
+export 'localization/intl/messages_ca.dart';
+export 'localization/intl/messages_cs.dart';
+export 'localization/intl/messages_de.dart';
+export 'localization/intl/messages_en.dart';
+export 'localization/intl/messages_es.dart';
+export 'localization/intl/messages_et.dart';
+export 'localization/intl/messages_fa.dart';
+export 'localization/intl/messages_fr.dart';
+export 'localization/intl/messages_hr.dart';
+export 'localization/intl/messages_hu.dart';
+export 'localization/intl/messages_id.dart';
+export 'localization/intl/messages_it.dart';
+export 'localization/intl/messages_ja.dart';
+export 'localization/intl/messages_ko.dart';
+export 'localization/intl/messages_lo.dart';
+export 'localization/intl/messages_ms.dart';
+export 'localization/intl/messages_nl.dart';
+export 'localization/intl/messages_pl.dart';
+export 'localization/intl/messages_pt.dart';
+export 'localization/intl/messages_ro.dart';
+export 'localization/intl/messages_ru.dart';
+export 'localization/intl/messages_sk.dart';
+export 'localization/intl/messages_sl.dart';
+export 'localization/intl/messages_sw.dart';
+export 'localization/intl/messages_th.dart';
+export 'localization/intl/messages_tr.dart';
+export 'localization/intl/messages_uk.dart';
+export 'localization/intl/messages_zh.dart';
 export 'localization/l10n.dart';
 export 'src/form_builder_validators.dart';

lib/l10n/intl_messages.arb

@@ -1,6 +1,6 @@
 {
   "@@last_modified": "2021-12-24T02:25:04.576038Z",
-  "@@locale": "zh_Hans",
+  "@@locale": "zh",
   "requiredErrorText": "此字段不能为空。",
   "@requiredErrorText": {
     "description": "Error Text for required field",