excel_to_arb 1.0.3
excel_to_arb: ^1.0.3 copied to clipboard
A command-line tool to convert Excel localization files into ARB (Application Resource Bundle) format for Flutter/Dart internationalization.
Excel to ARB Converter #
A command-line tool that simplifies localization management by converting Excel spreadsheets (.xlsx) into Flutter's ARB (Application Resource Bundle) format. Streamline your internationalization workflow and ensure consistent translations across your app.
Features #
- Effortless Conversion: Quickly transforms
.xlsxfiles into.arbfiles. - Placeholder Support: Automatically handles dynamic values (e.g.,
{name}) with type definitions for robust localization. - Description Inclusion: Supports adding descriptive context for each translation key.
- Command-Line Interface: Easy to integrate into your build or CI/CD workflows using familiar flags.
Installation #
You can activate this tool globally on your system, making it accessible from any directory.
dart pub global activate excel_to_arb
Usage #
Excel File Preparation #
- Name must follow pattern: app_*.xlsx (e.g.,
app_my.xlsx) - Structure your spreadsheet with these columns:
| Key | Value | Description (optional) | Placeholder (name:type) |
|---|---|---|---|
| hello | မင်္ဂလာပါ | Greeting text | name:String , age: int |
| goodbye | နုတ်ဆက်ပါတယ် | Farewell text | name:String , age: int |
Example Files: You can find sample Excel files demonstrating this structure in the resources/l10n directory of this repository:
https://github.com/Kaung-Myat/excel_to_arb/tree/main/resources/l10n
Running the Converter #
Once your Excel files are prepared, run the tool from your terminal.
excel_to_arb --source <path/to/source/excel/dir> --target <path/to/target/arb/dir>
Arguments: #
-
-s,--source: (Required) The path to the directory containing yourapp_*.xlsxfiles. -
-t,--target: (Required) The path to the directory where the generatedapp_*.arbfiles will be saved. The tool will create this directory if it doesn't exist. -
-h,--help: Displays usage information and available options.
Example #
excel_to_arb --source /path/to/your_project/resources/l10n --target /path/to/your_project/config/l10n
Contributing #
We welcome contributions! If you have ideas for improvements, bug reports, or want to add new features, please check out our GitHub repository and open an issue or pull request.
License #
This project is licensed under the MIT License.