auto_localize 0.0.5

A command-line utility that automatically scans your Flutter project to find hardcoded UI strings and replaces them with localization keys. Supports multiple localization packages including GetX and F [...]

Flutter Localization Automation Tool

A command-line utility that automatically scans your Flutter project to find hardcoded UI strings and replaces them with localization keys. Supports multiple localization packages including GetX and Flutter's built-in localization.

Orignally Forked from localize_generator_keys by Abdelrahman Abdelsalam This is my own opinionated version of the tool, I added some features.

What This Tool Does

This script automates the tedious process of manually implementing localization in Flutter projects by:

1. Scanning Dart Files: Recursively searches through your project's lib directory for hardcoded strings in UI widgets.

2. Identifying Text Patterns: Detects various text widget patterns including:

   • Standard Text widgets
   • Text inside buttons and other widgets
   • TextSpan components
   • RichText widgets
   • Text with complex string interpolation (e.g., 'Expires: ${DateFormat('MMM dd, yyyy').format(item.priceExpiry!)}')

3. String Replacement:

   • Converts simple strings like Text('Hello') to Text('hello'.tr)
   • Handles complex strings with variables using trParams method
   • Preserves expressions inside string interpolations

4. JSON Generation:

   • Creates a JSON translation file with original strings as values
   • Maintains placeholders for interpolated variables
   • Supports custom translation keys via .tr.json files

5. Multiple Package Support:

   • Supports GetX (default), Flutter's built-in localization, and more
   • Adds the necessary imports automatically
   • Removes the const keyword where needed for compatibility

Installation

Add this to your pubspec.yaml:

dependencies:
  auto_localize: ^0.0.1
  get: ^4.6.5  # Required for the .tr and .trParams methods

Or install it from the command line:

flutter pub add auto_localize

Usage

As a Command-Line Tool

You can run the tool directly from the command line:

# Navigate to your Flutter project
cd path/to/your/flutter/project

# Run the localization tool with default settings (GetX, 'en' language)
dart run auto_localize

# Run with a specific language
dart run auto_localize [language_code]

# Run with a specific language and package
dart run auto_localize [project_path] [language_code] [package_name]

Supported package names:

• getx (default)
• flutter_intl (Flutter's built-in localization)

Or install it globally:

dart pub global activate auto_localize

Then run it from anywhere:

auto_localize [project_path] [language_code] [package_name]

Programmatic Usage

You can also use the package programmatically in your Dart code:

import 'package:auto_localize/auto_localize.dart';

Future<void> main() async {
  // Run with default settings (current directory, 'en' language, GetX package)
  await localize();

  // Or with custom settings
  await localize(
    projectPath: '/path/to/your/project',
    lang: 'fr',
    packageName: 'getx', // 'getx' or 'flutter_intl'
  );
}

Setting Up Translations

After running the tool, you'll need to set up your chosen localization package to use the generated translations:

GetX Setup

1. Add the following code to your main.dart file:

import 'package:flutter/material.dart';
import 'package:get/get.dart';
import 'dart:convert';
import 'dart:io';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // Load translations
  await loadTranslations();

  runApp(MyApp());
}

Future<void> loadTranslations() async {
  // Define supported languages
  final languages = ['en', 'fr', 'es']; // Add your supported languages

  for (final lang in languages) {
    try {
      final jsonString = await rootBundle.loadString('assets/lang/lang_$lang.json');
      final Map<String, dynamic> translations = json.decode(jsonString);
      Get.addTranslations({lang: translations});
    } catch (e) {
      print('Failed to load $lang translations: $e');
    }
  }

  // Set default language
  Get.locale = const Locale('en', 'US');
  Get.fallbackLocale = const Locale('en', 'US');
}

2. Wrap your app with GetMaterialApp:

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return GetMaterialApp(
      title: 'My App',
      translations: GetxTranslations(), // Your translations class if needed
      locale: Get.locale,
      fallbackLocale: Get.fallbackLocale,
      home: HomePage(),
    );
  }
}

Flutter Intl Setup

1. Configure your l10n.yaml file in the root of your project:

arb-dir: assets/lang
template-arb-file: lang_en.json
output-localization-file: app_localizations.dart

2. Add the following to your pubspec.yaml:

dependencies:
  flutter:
    sdk: flutter
  flutter_localizations:
    sdk: flutter

flutter:
  generate: true

3. Use the generated localizations in your app:

import 'package:flutter/material.dart';
import 'package:flutter_gen/gen_l10n/app_localizations.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      localizationsDelegates: AppLocalizations.localizationsDelegates,
      supportedLocales: AppLocalizations.supportedLocales,
      home: MyHomePage(),
    );
  }
}

Advanced Flutter Intl Features

The Flutter Intl implementation supports advanced features like placeholders, plurals, and selects:

1. Placeholders: Variables in strings are automatically converted to named parameters:

// Original: "Hello, $name!"
// Generated ARB:
// "greeting": "Hello, {name}!",
// "@greeting": {
//   "description": "A greeting message",
//   "placeholders": {
//     "name": {
//       "type": "String",
//       "example": "John"
//     }
//   }
// }

// Usage:
Text(AppLocalizations.of(context)!.greeting(name: userName))

2. Plurals: Number variables are automatically detected and can be used with plural forms:

// Original: "You have $count messages"
// Generated ARB:
// "messageCount": "{count, plural, =0{No messages} =1{One message} other{{count} messages}}",
// "@messageCount": {
//   "description": "Message count",
//   "placeholders": {
//     "count": {
//       "type": "num",
//       "format": "compact"
//     }
//   }
// }

// Usage:
Text(AppLocalizations.of(context)!.messageCount(count: messages.length))

3. Selects: String variables with specific names (gender, type, etc.) can be used with select statements:

// Original: "The $gender student"
// Generated ARB:
// "studentGender": "{gender, select, male{He} female{She} other{They}}",
// "@studentGender": {
//   "description": "Student gender pronoun",
//   "placeholders": {
//     "gender": {
//       "type": "String"
//     }
//   }
// }

// Usage:
Text(AppLocalizations.of(context)!.studentGender(gender: userGender))

Custom Translation Keys

You can add custom translation keys by creating .tr.json files anywhere in your lib directory. These files will be automatically detected and merged with the auto-generated translations.

Creating Custom Translation Files

1. Create a file with the .tr.json extension in any subdirectory of your lib folder.
2. Add your custom translation keys in JSON format:

{
  "custom_greeting": "Hello, welcome to our app!",
  "app_version": "Version 1.0.0",
  "terms_and_conditions": "By using this app, you agree to our terms and conditions...",
  "custom_with_variable": "Hello, @name! Welcome back."
}

3. Run the localization tool as usual, and your custom keys will be merged with the auto-generated ones.

Benefits of Custom Translation Files

• Organize translations by feature or module
• Add complex or lengthy translations that would be impractical as hardcoded strings
• Manually define specific keys for important strings
• Keep critical translations separate from auto-generated ones

Example Structure

lib/
├── main.dart
├── home/
│   ├── home_screen.dart
│   └── home_translations.tr.json
├── auth/
│   ├── login_screen.dart
│   └── auth_translations.tr.json
└── settings/
    ├── settings_screen.dart
    └── settings_translations.tr.json

Running Tests

To run the tests for this package:

flutter test

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.