language_helper 0.13.0-rc.13

language_helper: ^0.13.0-rc.13 copied to clipboard

BREAKING CHANGE Change the behavior of the initial.data from loading the first successful provider to loading all providers and decide to override the translations by setting override parameter of each provider. The providers will be loaded from top to bottom.

BREAKING CHANGE Remove dataOverrides and codesOverrides properties from LanguageHelper. The override functionality is now handled by the override parameter in LanguageDataProvider constructors.

BREAKING CHANGE Remove addDataOverrides method. Use addProvider with a provider that has override: true instead.

BREAKING CHANGE Rename addData to addProvider and add removeProvider method for better clarity and consistency.

BEHAVIOR CHANGE The change() method now always reloads translation data from all providers on every language change, even if the data was previously loaded. This ensures fresh data but may impact performance for network providers. Previously, data was only loaded if it wasn't already cached.

Add reload() method to refresh all LanguageBuilder widgets without changing the language. Useful after adding/removing providers with activate: false.

Enhance documentation throughout the codebase with comprehensive examples and usage guidelines.

Update README with improved examples, performance considerations, and best practices for using different provider types.

Update example code to use the new addProvider method.

MIGRATION

• Replace languageHelper.addData(provider) with languageHelper.addProvider(provider)
• Replace languageHelper.addDataOverrides(provider) with languageHelper.addProvider(provider) (the provider's override property controls whether it overwrites existing translations)
• Replace languageHelper.dataOverrides with languageHelper.data (all providers are now unified)
• Replace languageHelper.codesOverrides with languageHelper.codes (all language codes are now unified)

BREAKING CHANGE Remove analyze() method from LanguageHelper. Missing translation detection is now handled by language_helper_generator package.

BREAKING CHANGE Remove analysisKeys parameter from LanguageHelper.initial(). The generator will automatically detect and report missing translations.

BREAKING CHANGE The forceRebuild parameter in LanguageHelper.initial() now defaults to true instead of false. This change makes it easier to use nested LanguageBuilder widgets since they will rebuild by default when the language changes. Previously, only the root LanguageBuilder would rebuild, which made nested builders less useful.

Update tests to reflect the removal of analysis functionality.

MIGRATION: If you want the old behavior (only root widgets rebuild), use LanguageHelper.initial(forceRebuild: false).

Add LanguageBuilder.refreshTree to rebuild the whole tree when the language is changed.

The LanguageBuilder will not find the root widget itself, the LanguageHelper.change will do it to improve the performance.

The recent refactor of language_helper_generator v0.7.0 now allows you to use the previous asset and network structure for greater flexibility. The language_helper segment is no longer required in your asset or network paths, restoring compatibility with older versions.

• Before: The language_helper is required so we don't need to add it the the path/url

LanguageDataProvider.asset('assets/resources');
LanguageDataProvider.network('https://example.com/resources');  

• Now: The required of language_helper is removed, so we need to add it ourself

LanguageDataProvider.asset('assets/resources/language_helper');
LanguageDataProvider.network('https://example.com/resources/language_helper');

Rewrite the example.

• Change the generated path in Map from '@path_1': '.lib/to/file.dart' to "@path_.lib/to/file.dart": ''

Improve the logic of using the temporary data while developing.

• Right:

languageHelper.initial(
  data: []
);

• Wrong:

languageHelper.initial(
  data: [LanguageDataProvider.data({})],
);

assets data is preferred between assets and network because we still haven't a way to cache it.

The language_helper in .asset and .network of LanguageDataProvider are now required. So we don't need to add it into the input path:

• Before:

LanguageDataProvider.asset('assets/resources/language_helper');
LanguageDataProvider.network('https://example.com/resources/language_helper');

• Now:

LanguageDataProvider.asset('assets/resources');
LanguageDataProvider.network('https://example.com/resources');  

Generator:

• Change the default path of the Dart Map generator:

  • Before:

  |-- .lib
  |   |--- resources
  |   |    |--- language_helper
  |   |    |    |--- _language_data_abstract.g.dart   ; This file will be overwritten when generating
  |   |    |    |--- language_data.dart
  

  • Now:

  |-- .lib
  |   |--- resources
  |   |    |--- language_helper
  |   |    |    |--- language_data.dart
  |   |    |    |--- languages
  |   |    |    |    |--- _generated.dart   ; This will be overwritten when re-generating
  

• Change the default path of the Dart Map generator:

  • Before:

  |-- assets
  |   |--- language_helper
  |   |    |--- codes.json   ; List of supported language code
  |   |    |--- languages
  |   |    |    |--- _generated.json ; Each language will be stored in 1 files
  

  • Now:

  |-- assets
  |   |--- resources
  |   |    |--- language_helper
  |   |    |    |--- codes.json
  |   |    |    |--- languages
  |   |    |    |   |--- _generated.json ; This file will be overwritten when re-generating
  

• JSON generator will not overwrite the codes.json when re-generating.

• BREAKING CHANGE NOTE: The method .fromEnglishName and .fromNativeName may be broken in this version with this Changelog.

• Completely rewritten using dart analyzer to improve reliability.

• Convert to single quote when possible to avoid duplicated text issue.
• Able to parse a text with r raw text tag.

Add codesBoth to LanguageHelper in order to get the LanguageCodess from both data and dataOverrides (No duplicated).

Update dependencies.

language_helper_generator:

• Improve the commented text.
• Improve TODO text.

• Use data.toJson() to convert the data to JSON.
• Use LanguageDataSerializer.fromJson(json) to convert the JSON data back to the LanguageData.

[BREAKING CHANGE] the initial method will return Future, so you need to use await to make it equal to before.

The app will try use Devicelocale as the default language code if the initialCode is not set.

Added useInitialCodeWhenUnavailable parameter to control the LanguageCodes when you change to unavailable code.

Added trP() extension to allow replacing specific texts by values. Ex:

final text = 'Hello @user'.trP({'user' : 'Vursin'}); // => Hello Vursin

Added test.