🌐 r13n

Developed with 💙 by Very Good Ventures 🦄

A brick that generates regionalization (r13n) code from arb files. Designed to be used in conjunction with the r13n Flutter package.

Getting Started 🚀

1. Add a new yaml file to the root directory of the Flutter project called r13n.yaml with the following content:

arb-dir: lib/r13n/arb
template-arb-file: app_us.arb

2. Next, add an app_us.arb file in the same directory specified by r13n.yaml, which is lib/r13n/arb:

├── r13n
│   ├── arb
│   │   └── app_us.arb

3. Following, add the regionalized strings to your .arb file:

app_us.arb

{
    "@@region": "us",
    "supportEmail": "[email protected]"
}

4. To generate regionalization code use the following command:

$ mason make r13n --on-conflict overwrite

6. You should see generated files in lib/r13n/arb/gen:

├── r13n
│   ├── arb
│   │   ├── gen
│   │   │   ├── app_regionalizations_us.g.dart
│   │   │   └── app_regionalizations.g.dart
│   │   ├── app_us.arb

Configuring r13n.yaml ⚙️

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 r13n

# Install globally
mason add -g r13n

Usage 🚀

mason make r13n

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

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

0.1.0-dev.8

• refactor: decompose hooks into multiple files (#43)
• chore: update dart, analysis and fix lint (#57)

0.1.0-dev.7

• fix: only format arb directory in post_gen hook

0.1.0-dev.7

• fix: only format arb directory in post_gen hook

0.1.0-dev.6

• docs: remove copyright header from generated code

0.1.0-dev.5

• fix: error when running mason make r13n

0.1.0-dev.4

• feat: add runtime compatibility check on package:r13n

0.1.0-dev.3

• fix: use super.key in generated AppRegionalizations

0.1.0-dev.2

• chore: includes VGV copyright notice on generated files

0.1.0-dev.1

• feat: initial brick to generate regionalization (r13n) code from arb files

MIT License

Copyright (c) 2022 Very Good Ventures

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.