Language Helper Generator

Features

  • Create a base structure and data for language_helper.

  • This runner will get all the texts that using language_helper extensions (tr, trP, trT, trF) and translate method then creating a base structure for LanguageData.

  • Uses Dart Analyzer and doesn't depend on build_runner so it's very fast and reliable.

Usage

Install language_helper_generator to your pubspec.yaml dev dependencies:

dev_dependencies:
  language_helper_generator: ^latest

Run this command to generate the language from current project.

dart run language_helper_generator

If you want to change the generating path, you can add this option:

dart run language_helper_generator --path=./example/lib/resources

If you want to export as Json format to use as LanguageDataProvider.asset() and LanguageDataProvider.network(), you need to add this flag:

dart run language_helper_generator --json

Generated Data

With the json flag

This command will generate a structure base files with this format (--path=".assets" by default):

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

Without the json flag

This command will generate a structure base files with this format (--path=".lib/resources" by default):

|-- lib
|   |--- resources
|   |    |--- language_helper
|   |    |    |--- language_data.dart
|   |    |    |--- languages
|   |    |    |    |--- _generated.dart   ; This file will be overwritten when re-generating
  • _generated.dart: Contains your base language from your all .dart files. This file will be re-generated when you run the command.
  • language_data.dart: Modifiable language data because it's only generated 1 time.

In the _generated.dart, data will be shown like this:

const analysisLanguageData = {
  ///===========================================================================
  /// Path: ./lib/page_1/page_1.dart
  ///===========================================================================
  "@path_./lib/page_1/page_1.dart": '',
  "Hello, world! 1": "Hello, world! 1",
  'This is a "quoted" string 1': 'This is a "quoted" string 1',
  "This is a 'quoted' string 1": "This is a 'quoted' string 1",
  // 'This text contains variable $text7': 'This text contains variable $text7',  // Contains variable

  ///===========================================================================
  /// Path: ./lib/page_1/page_2.dart
  ///===========================================================================
  "@path_./lib/page_1/page_2.dart": '',
  // "Hello, world! 1": "Hello, world! 1",  // Duplicated
  // 'This is a "quoted" string 1': 'This is a "quoted" string 1',  // Duplicated
  "This is a 'quoted' string 2": "This is a 'quoted' string 2",
}

In the language_data.dart, data will be shown like this:

LanguageData languageData = {
  // TODO: You can use this data as your main language, remember to change this code to your base language code
  LanguageCodes.en: analysisLanguageData,
};

You can use the analysisLanguageData as your main language if you feel it's detailed enough. After that, you can update your other languages by looking at the _generated.g.dart. This file will contains all the texts that ending with the supported extensions of LanguageHelper.

If you don't want to use analysisLanguageData as your main language, you can use it for analysis by adding it to the initial like this:

  await LanguageHelper.instance.initial(
    data: data, // <--- This is your data
    analysisKeys: analysisLanguageData.keys, // <--- This is the generated data
    initialCode: LanguageCodes.en,
    isDebug: !kReleaseMode,
  );

Contributions

The package is currently in its early development stage and may have bugs. If you have any questions, please don't hesitate to file an issue. We are also open to pull requests.

Libraries

language_helper_generator