localiz

Getting Started 🚀

Localiz Ease the integration of arb localization into your flutter project with list of predefined languages (English, Arabic, Chinese...), the brick automatically adds the required packages to your project. This brick implement the official flutter-way to localize your app Full documentation

Features

• Integrate l10n folder contains all your arb files.
• Add required packages to your pubspec file
• Add arb configuration
• Add Gemini API Key

Usage 👨🏻‍💻👩🏻‍💻

1- Run the following command in your terminal to add localiz to your mason local config

mason add localiz

2- Run the following command in your terminal to generate localiz brick

mason make localiz

Localiz will ask you about the languages you want to include into your project

Input Variables

• The langauges you want to add to your flutter project
• The default arb template language
• The Gemini API Key if you want to add translation API see details

Output Files 🔥

• l10n folder under lib folder, contains all the arb files for each selected language
• l10n.yaml under your project folder, this files contains all the configurations of arb localization

Contributing ⚽

If you want to contribute to this project send me all your PRs and Issues here's the Github Repo Link.

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add localiz

# Install globally
mason add -g localiz

Usage 🚀

mason make localiz

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.51 <0.1.0"

1.2.1+1 - 18/05/2024

Added

• Added prompt from whether add Gemini API Key or not
• New prompt asking for Gemini API Key
• Updated l10n.yaml file to add arb-translate-api-key

Fixed

• Fixing pubspec config file, when pubspec file conatins "generate: true" the brick won't update it.

Changed

• Updated intl version installed with the brick from fixed version 0.18.1 to the latest version.

1.1.1+1 - 18/05/2024

• Update brick github repository

1.1.0+1 - 11/05/2024

• Update package and dependencies installation log
• Add pubspec configuration when generating l10n
• Update languages parameter prompt message

1.0.0+1 - 05/05/2024

• Add predefined languages variable
• Add default arb template language variable
• Install required packages to flutter project
• Add arb configuration and arb language files

MIT License

Copyright (c) 2022 Cem Avcı

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.