arb_excel_converter_tool 1.0.2

A command-line tool to convert Flutter's ARB localization files into a translatable Excel spreadsheet (XLSX).

🚀 ARB Excel Converter Tool

A powerful command-line utility to convert Flutter's .arb localization files into a translatable Excel spreadsheet (.xlsx).

This tool simplifies the localization workflow by extracting keys, values, and descriptions from your primary .arb file into a structured spreadsheet, making it easy for translators to work with.

---

✨ Features

• Key Extraction: Extracts all localization keys (e.g., helloWorld).
• Value Extraction: Extracts the default language value (e.g., "Hello World").
• Description Support: Includes the @description metadata, providing context for translators.
• Clean Output: Generates a single Excel file with a clear structure (Key, Value, Description).
• Zero Config: Optimized for standard Flutter localization projects.

---

📦 Installation

This is a global command-line tool published on pub.dev.

1. Activate the Tool Globally

Install the package directly from pub.dev using the Dart package manager:

dart pub global activate arb_excel_converter_tool

2. Verify Installation

Ensure your Dart SDK bin folder is in your system's PATH, then check if the tool is ready:

arb_export --help

---

📖 How to Use

Always run the command from the root directory of your Flutter project (where your pubspec.yaml is located).

1. Basic Conversion (Recommended)

If your localization file is in the default Flutter path (lib/l10n/app_en.arb), simply run:

arb_export

This will automatically generate a file named localization_export.xlsx in your current folder.

2. Custom Input and Output

If you have a custom file name or want to specify the output location:

arb_export --input lib/l10n/intl_en.arb --output my_translations.xlsx

3. Usage with Absolute Paths

You can also point to files outside your current directory by providing the full path:

arb_export -i /Users/name/Projects/myapp/lib/l10n/app_en.arb -o /Users/name/Desktop/export.xlsx

---

🛠 Available Options

Option	Short	Default	Description
--input	-i	lib/l10n/app_en.arb	Path to the source .arb file.
--output	-o	localization_export.xlsx	Path/Name for the generated .xlsx file.
--help	-h	N/A	Show all available flags and usage instructions.

---

📝 Example Mapping

The tool converts your JSON-based ARB data into a structured table:

ARB Input:

{
  "loginTitle": "Welcome Back",
  "@loginTitle": {
    "description": "The title shown on the login screen"
  }
}

Excel Output:

Key	Value	Description
loginTitle	Welcome Back	The title shown on the login screen

---

💡 Troubleshooting

• "Command not found": Make sure the Dart SDK global binaries are in your system PATH.
• "File not found": Ensure you are running the command from the project root or providing the correct relative path to your .arb file.
• Crash on MacOS: Ensure you are using version 1.0.2 or higher to avoid "unmodifiable list" errors.

---

🤝 Feedback & Issues

I created this tool to make Flutter localization easier! If you find any issues or have a feature request, please report them on the GitHub Issues page.

Created by Mohit