fast_i18n 5.7.0

fast_i18n: ^5.7.0 copied to clipboard

• feat: add option to disable timestamp generation
• feat: add option to split output file
• perf: flat translation map now declared separately for each locale

• feat: add CSV support
• feat: improve generic type detection for lists (e.g. List<List<String>>,List<Map<String, String>>)
• feat: make optional class members (from interfaces) non-nullable when possible

Namespaces

Split your translations into different files. Each file represents a namespace:

i18n/
  widgets/
    - widgets.i18n.json
    - widgets_fr.i18n.json
  dialogs/
    - dialogs.i18n.json
    - dialogs_fr.i18n.json

Interfaces

Create common super classes for different nodes. This allows for more type safety. Instead of List<dynamic>, we can have List<PageData>

{
  "pages": [
    {
      "title": "E2E encryption",
      "content": "Your data is safe!"
    },
    {
      "title": "Sync",
      "content": "Synchronize all your devices!"
    }
  ]
}

With the generated mixin:

mixin PageData {
  String get title;
  String get content;
}

See updated README for further information about those features.

• feat: add default plural resolvers for Spanish, French and Italian (Thanks to @SimoneBressan)

• feat: handle linked translations with parameters

• feat: add YAML support, you can now choose between JSON and YAML to define your translations!
• feat: different casing for map keys via key_map_case

New recommended setup (see README):

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  // LocaleSettings.useDeviceLocale();
  runApp(TranslationProvider(child: MyApp())); // Wrap your app with TranslationProvider
}

MaterialApp(
  locale: TranslationProvider.of(context).flutterLocale, // use provider
  supportedLocales: LocaleSettings.supportedLocales,
  localizationsDelegates: GlobalMaterialLocalizations.delegates,
)

• feat: add param_case configuration to recase parameters

• fix: always escape $ for braces and double_braces, escape $ for dart if this symbol is alone

• fix: For country code only, india instead of in will be used for enum constant (in is a reserved keyword)
• fix: When using country code only, the correct device locale will be selected

• fix: transform keys with multiple digits according to key_case correctly

• fix: Missing PluralResolver when pluralization is not used in project

This release mostly focuses on simplifications of build.yaml.

• Breaking: builder name renamed from fast_i18n:i18nBuilder to fast_i18n
• Breaking: plural auto detection is on by default (auto: cardinal)
• Breaking: fallback strategy option strict is now none
• Breaking: key paths in build.yaml must be cased according to key_case if specified
• Breaking: your project must be null safe
• feat: generated file follows lint guidelines
• feat: add support for linked translations, e.g. Welcome to @:appName

You can read the detailed migration guide here.

• feat: simplify ${arg} to $arg if possible
• feat: make internal translation class instance final

Added support for custom contexts. Example:

{
  "greet": {
    "male": "Hello Mr $name",
    "female": "Hello Ms $name"
  }
}

String a = t.greet(name: 'Anna', context: GenderContext.female);

For more information, see README.

• fix: call setLocale without WidgetsBinding
• docs: update README

• fix: generate default plural resolvers when auto pluralization is used

• feat: detect pluralization automatically, configure it via pluralization->auto: cardinal / ordinal

• feat: add option to turn off flat map generation via flat_map: false
• feat: add fallback_strategy configuration, possible values strict (default), base_locale
• feat: auto rebuild flutter pub run fast_i18n watch (experimental)
• fix: escape parameters with backslash correctly

• fix: handle string interpolation at the beginning (for braces and double_braces)

• fix: build_runner generation error

• feat: new string_interpolation configuration. Possible values: dart (default), braces and double_braces

• fix: restore non-nullsafety compatibility

• fix: handle text nodes at root level, i.e. t['someKey']

• fix: missing key parameter

• feat: add flat translation map, accessible via t['someKey.anotherKey']

• feat: remove hint when overriding plural resolvers (were too verbose)
• feat: generated plural resolvers fallback to default quantity if null
• feat: add zero quantity to cs, de, en and vi (not breaking)
• docs: it is now recommended to put this library into dev_dependencies

• fix: @ for required missing (Flutter 1.x.x)
• fix: null_safety is true by default (as intended in 4.4.0)

• feat: add Flutter 1.x.x support, build_runner detects this automatically, otherwise set null_safety: false in build.yaml
• feat: flutter pub run fast_i18n ignores build.yaml files without fast_i18n entry
• fix: add type hint for _renderedResolvers

• feat: plural resolvers can now be overwritten
• fix: make params distinct
• fix: sort locales correctly (base first, then alphabetically)

• feat: add pluralization support
• feat: AppLocale has a new property called flutterLocale
• feat: new command flutter pub run fast_i18n which is much faster than flutter pub run build_runner build --delete-conflicting-outputs

• fix: LocaleSettings.setLocaleRaw for locales encoded with underscore _
• docs: update README

A rebuild is needed: flutter pub run build_runner build.

• feat: the generated file is now self-contained, it works even if you remove this library!
• feat: add stats and timestamp to the generated file
• fix: parse files with underscore only (e.g. strings_en_US)
• fix: parse files with script tag (e.g. strings_zh-Hant-TW)
• perf: generate LocaleSettings.supportedLocales statically without library call
• perf: remove switch call in Translations.of(context).
• docs: updates in generated file
• docs: update README

The typed version is now first class.

• Breaking: setLocale -> setLocaleRaw, setLocaleTyped -> setLocale
• Breaking: locales -> supportedLocalesRaw
• Breaking: AppLocale.toLanguageTag -> AppLocale.languageTag
• Breaking: translation classes are now private by default, you can configure it via translation_class_visibility in build.yaml (in most cases just keep it private!)
• plain strings are now implemented via getters, edit json -> rebuild i18n -> hot reload works now for faster development

• fix LocaleSettings.useDeviceLocale() causing compilation error (Flutter Web)

• docs: add hint for .i18n.json extension
• docs: update code examples
• docs: update image

• new optional case transformation: pascal
• remove recase dependency
• code changes in generated .g.dart file

• add real project example
• update FAQ in README
• depend on null-safety version of recase package

• null safety support
• add type-safe functions LocaleSettings.setLocaleTyped and LocaleSettings.currentLocaleTyped
• Breaking: output_translate_var renamed to translate_var in build.yaml

• Make locales case sensitive to comply with MaterialApp's supportedLocales.

• Add supportedLocales property that can be used to fill MaterialApp's supportedLocales argument.

• Fix compilation error occurring when non-standard name (not 'strings.i18n.json') is used for json files.

• new config: output_translate_var, renames default t variable
• internal: device locale now fetched via Platform.localeName

A rebuild is needed: flutter pub run build_runner build.

• API change: LocaleSettings.useDeviceLocale() is no longer asynchronous and now returns the new locale (was Future<void>)
• API change: LocaleSettings.setLocale(locale) now also returns the new locale (was void)

Just in case you use internal API: FastI18n.findDeviceLocale has been renamed to FastI18n.getDeviceLocale

Thanks to @DenchikBY (https://github.com/DenchikBY).

• Now it's possible to set in and out directories for files.
• You can set the pattern by which to search for files.
• Generated keys can be switched to another case in generated classes.
• Removed dependency on devicelocale.
• Configs with baseLocale and maps moved from config.i18n.json to build.yaml
• Generators replaced with fields for keys with static values.
• Arguments now can be wrapped with braces like ${key}.
• Removed deprecated #map mode (deprecated in 1.5.0)

Example of new config in build.yaml:

targets:
  $default:
    builders:
      fast_i18n:i18nBuilder:
        options:
          base_locale: en
          input_directory: lib/i18n
          input_file_pattern: .i18n.json
          output_directory: lib/i18n
          output_file_pattern: .g.dart
          key_case: snake
          maps:
            - a
            - b
            - c.d

• Hotfix: possible NPE when calling Translations.of(context)

• Hotfix: possible NPE error when calling LocaleSettings.useDeviceLocale or LocaleSettings.setLocale

• New advanced mode: final t = Translations.of(context)

• Prefer language code over region code.

• Add more unit tests.
• Code Polishing.

• Generates List<String> or Map<String, String> instead of List<dynamic> or Map<String, dynamic> if the children are only strings.
• You will experience a better autocompletion like .substring, .indexOf, etc. because of that.

• Define additional metadata in the config.i18n.json file.
• Maps defined with #map are now deprecated. Use config.i18n.json for that.
• Add LocaleSettings.locales to get the supported locales.

• Add support for country codes. Use e.g. strings_en_US.i18n.json or strings_en-US.i18n.json.
• Add fallback for LocaleSettings.setLocale if locale is not supported.

• Add support for lists.
• Add support for maps. Use { "#map": "" } to enable map inlining.

• Only one single .g.dart will be generated

• Fix iOS bug in LocaleSettings.useDeviceLocale

• Fix for LocaleSettings.useDeviceLocale

• Add LocaleSettings.useDeviceLocale()

• Initial Release
• basic json support (no arrays)