best_localization 3.0.0

A Flutter localization package with dynamic translations and Kurdish support.

Changelog

All notable changes to this project will be documented in this file.

<<<<<<< HEAD

3.0.0 - 2026-06-27

⚠️ Breaking Changes

• Kurdish Locale Code Realignment:
  • Kurdish Sorani language code changed from ku to ckb.
  • Kurdish Kurmanji is now officially supported using language code ku. Note: If your app previously used ku for Sorani, you must rename your translation files (e.g., ku.json to ckb.json) and update your app's supported locales list to prevent broken layouts or missing translations.

✨ New Features

• Official Kurdish Kurmanji (ku) Support: Added complete localization support including Material and Cupertino widgets.

2.0.4 2026-2-5

Breaking Changes

• Updated all loader type signatures to support complex translation values
  • Changed from Map<String, Map<String, String>> to Map<String, Map<String, Object>>
  • Now supports pluralization, gender-specific translations, and nested structures
  • Affects all loaders: JsonLoader, YamlLoader, XmlLoader, CsvLoader, HttpLoader
  • Translation values can now be strings, maps (for plurals/gender), or other objects

Fix

• Fixed type compatibility issues with pluralization and gender-specific translations
• All loaders now properly preserve complex translation structures instead of converting to strings

2.0.3 2026-1-1

Fix

• Fix an issue with cupertino

2.0.2 - 2025-12-31

Fix

• Fix an issue with cupertino

2.0.1 - 2025-12-31

Fix

• Fix an issue with cupertino

  cff1ecbc7b2a2389e189b58d4cce8bac3ed11cf2

2.0.0 - 2025-12-22

New Features

• Directly Translate throu Text method or String
• Text('hello').tr() or Text('hello').translate()
• New way of gender and plural

Fix

• Issue of gender and plural fixed

1.2.1 - 2025-11-16

🎉 New Features

Added

• Translation Key Verification Tool 🔍
  • TranslationVerifier class for programmatic verification
  • Command-line tool: dart run best_localization:verify_translations
  • Verify all translations against a reference locale
  • Compare two specific locales
  • Find duplicate values (same translation for different keys)
  • Find similar keys (potential typos using Levenshtein distance)
  • Generate detailed reports in text or JSON format
  • Calculate coverage percentage per locale
  • CI/CD integration support with exit codes
  • Pre-commit hook examples
  • Commands:
    • verify <path> - Verify all translation files
    • compare <file1> <file2> - Compare two files
    • duplicates <file> - Find duplicate values
    • similar <file> - Find similar keys
  • Features:
    • Missing key detection
    • Extra key detection
    • Empty value detection
    • Duplicate value detection
    • Similar key detection (configurable threshold)
    • JSON output for automation
    • Reference locale selection

Documentation

• Added comprehensive VERIFICATION.md guide
• Updated README.md with verification tool section
• Added CI/CD integration examples
• Added programmatic usage examples
• Updated pubspec.yaml with executable entry

1.0.2 - 2025-11-15

• Enhance readme.md
• Some changes

1.0.0 - 2025-11-15

🎉 Major Release - New Features

Added

• Multiple File Format Support 🎉

  • JSON Loader: Load translations from JSON files (single or multiple files)
  • CSV Loader: Load translations from CSV files (columns or rows format)
  • YAML Loader: Load translations from YAML files
  • XML Loader: Load translations from XML files
  • HTTP Loader: Load translations from remote API with caching support

• Remote Translations 🎉

  • HttpLoader class for fetching translations from API
  • Automatic caching with shared_preferences
  • Configurable cache duration (default: 24 hours)
  • Custom HTTP headers support (for authentication)
  • Offline fallback using expired cache
  • Works seamlessly with Loaders.remote()

• Fallback Locale Support 🎉

  • Added fallbackLocale parameter to BestLocalizationDelegate
  • Automatic fallback to default language when translation is missing
  • Works with all loader types (JSON, CSV, YAML, XML, HTTP, Map)
  • Better UX for incomplete translations

• Loaders Class 🎉

  • Easy-to-use static methods for all loaders
  • Loaders.json() - Load from JSON files
  • Loaders.csv() - Load from CSV files
  • Loaders.yaml() - Load from YAML files
  • Loaders.xml() - Load from XML files
  • Loaders.remote() - Load from remote API
  • Loaders.jsonString() - Load from JSON string
  • Loaders.csvString() - Load from CSV string

• Factory Methods

  • BestLocalizationDelegate.fromJson() - Create delegate from JSON loader
  • BestLocalizationDelegate.fromCsv() - Create delegate from CSV loader
  • BestLocalizationDelegate.fromYaml() - Create delegate from YAML loader
  • BestLocalizationDelegate.fromXml() - Create delegate from XML loader
  • BestLocalizationDelegate.fromHttp() - Create delegate from HTTP loader
  • BestLocalizationDelegate.fromMap() - Create delegate from map
  • BestLocalizationDelegate.fromLoader() - Create delegate from any loader

• BuildContext Extensions

  • context.tr() - Translate with optional arguments
  • context.localization - Get BestLocalization instance
  • context.currentLocale - Get current locale
  • context.languageCode - Get language code
  • context.isKurdish - Check if Kurdish
  • context.isArabic - Check if Arabic
  • context.isEnglish - Check if English
  • context.isRTL - Check if RTL language
  • context.textDirection - Get text direction

Changed

• Updated package dependencies to use flexible version ranges
• Enhanced Kurdish Cupertino localizations with missing properties
• Improved code organization with separate loader files

Fixed

• Fixed missing implementations in KurdishCupertinoLocalizations
• Resolved compatibility issues with different Flutter versions

0.0.4 - 2025-06-05

upate

• update intl to 0.20.2

fix issues

• cupertino localization error

0.0.3 - 2025-03-21

added

• enhancement

0.0.2 - 2024-12-26

added

• add flutter_localizations installation

0.0.1 - 2024-12-25

Added

• Initial release of best_localization package.
• Support for dynamic translations using Dart maps.
• Interpolation for dynamic placeholders (e.g., Hello, {name}!).
• Pluralization for managing singular and plural text forms.
• Kurdish (ku) localization for Material and Cupertino widgets.
• Seamless integration with Flutter's localization system via BestLocalizationDelegate.
• Example implementations for both Material and Cupertino apps.
• Comprehensive date and number formatting for Kurdish using intl.

Fixed

• N/A (First release)

Changed

• N/A (First release)