add localization (#12)

Author: aliyazdi75

l10n.yaml

@@ -0,0 +1,7 @@
+template-arb-file: intl_en.arb
+output-localization-file: instreal_localizations.dart
+output-class: InstrealLocalizations
+preferred-supported-locales:
+  - en
+use-deferred-loading: true
+untranslated-messages-file: untranslated-messages.json

lib/l10n/README.md

@@ -0,0 +1,79 @@
+# Localization
+
+## Creating mew localization
+
+1. Add the title and string to `lib/l10n/intl_en.arb` for example:
+
+
+```dart
+"hello": "Hello",
+```
+
+2. Add translated map to `lib/l10n/intl_fr.arb` like this:
+
+```dart
+"hello": "Bonjour",
+```
+
+3. By running app, flutter generate all Localization see *Generating
+   Localizations*, but if you want to generate before running see
+   *Generating Localizations in the command line*
+
+4. To use localization first import `flutter_gen` like this:
+
+```dart
+import 'package:instreal/l10n/index.dart';
+```
+and then use the localization:
+```dart
+InstrealLocalizations.of(context)!.hello
+```
+
+### Note: if you have any untranslated message, flutter generates them in `untranslated-messages.json` and will be determined when you create a pull request to merge.
+
+## Creating new locale messages with variable
+
+When adding new strings to be localized, update `intl_en_.arb`, which is
+used by this project as the template. When creating new entries with variable, they
+have to be in the following format:
+
+```arb
+  "helloName": "Hello {name}",
+  "@helloName": {
+        "placeholders": {
+            "name": {}
+        }
+  },
+```
+
+In this example, `dartGetterVariableName` should be the Dart method/property
+name that you will be using in your localizations delegate.
+
+After adding the new message in `intl_en.arb`, it can be used in the app by
+regenerating the Localizations delegate.
+This allows use of the English message through your localizations delegate in
+the application code immediately without having to wait for the translations
+to be completed.
+
+## Generating localizations
+
+Running the application for the first time should generate a synthetic package
+containing the app's localizations through importing
+`package:flutter_gen/gen_l10n/`. The code is generated will be generated in
+`.dart_tool/flutter_gen/gen_l10n/`.
+
+The generated localizations code is updated every time `flutter run`
+is called, and during hot reload and restart. This means that updates to
+existing arb files can be made and seen in real time during app development.
+
+### Generating localizations in the command line
+
+First temporary remove `l10n.yaml` file and then from the root directory, run:
+
+```bash
+flutter gen-l10n \
+    --template-arb-file=intl_en.arb \
+    --output-localization-file=instreal_localizations.dart \
+    --output-class=InstrealLocalizations
+```
+Don't forget to restore `l10n.yaml` file!

lib/l10n/index.dart

@@ -0,0 +1 @@
+export 'package:flutter_gen/gen_l10n/instreal_localizations.dart';

lib/l10n/intl_en.arb

@@ -0,0 +1,4 @@
+{
+    "@@locale": "en",
+    "hello": "Hello"
+}

lib/l10n/intl_fr.arb

@@ -0,0 +1,4 @@
+{
+    "@@locale": "fr",
+    "hello": "Bonjour"
+}

lib/main.dart

@@ -1,4 +1,5 @@
 import 'package:flutter/material.dart';
+import 'package:instreal/l10n/index.dart';
 
 void main() {
   runApp(const MyApp());
@@ -12,6 +13,8 @@ class MyApp extends StatelessWidget {
   Widget build(BuildContext context) {
     return MaterialApp(
       title: 'Flutter Demo',
+      localizationsDelegates: InstrealLocalizations.localizationsDelegates,
+      supportedLocales: InstrealLocalizations.supportedLocales,
       theme: ThemeData(
         // This is the theme of your application.
         //
@@ -108,6 +111,9 @@ class _MyHomePageState extends State<MyHomePage> {
             const Text(
               'You have pushed the button this many times:',
             ),
+            Text(
+              InstrealLocalizations.of(context)!.hello,
+            ),
             Text(
               '$_counter',
               style: Theme.of(context).textTheme.headlineMedium,

pubspec.lock

@@ -37,10 +37,10 @@ packages:
     dependency: transitive
     description:
       name: collection
-      sha256: "4a07be6cb69c84d677a6c3096fcf960cc3285a8330b4603e0d463d15d9bd934c"
+      sha256: f092b211a4319e98e5ff58223576de6c2803db36221657b46c82574721240687
       url: "https://pub.dev"
     source: hosted
-    version: "1.17.1"
+    version: "1.17.2"
   cupertino_icons:
     dependency: "direct main"
     description:
@@ -70,11 +70,24 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "2.0.1"
+  flutter_localizations:
+    dependency: "direct main"
+    description: flutter
+    source: sdk
+    version: "0.0.0"
   flutter_test:
     dependency: "direct dev"
     description: flutter
     source: sdk
     version: "0.0.0"
+  intl:
+    dependency: "direct main"
+    description:
+      name: intl
+      sha256: "3bc132a9dbce73a7e4a21a17d06e1878839ffbf975568bc875c60537824b0c4d"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.18.1"
   js:
     dependency: transitive
     description:
@@ -103,10 +116,10 @@ packages:
     dependency: transitive
     description:
       name: material_color_utilities
-      sha256: d92141dc6fe1dad30722f9aa826c7fbc896d021d792f80678280601aff8cf724
+      sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41"
       url: "https://pub.dev"
     source: hosted
-    version: "0.2.0"
+    version: "0.5.0"
   meta:
     dependency: transitive
     description:
@@ -132,10 +145,10 @@ packages:
     dependency: transitive
     description:
       name: source_span
-      sha256: dd904f795d4b4f3b870833847c461801f6750a9fa8e61ea5ac53f9422b31f250
+      sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c"
       url: "https://pub.dev"
     source: hosted
-    version: "1.9.1"
+    version: "1.10.0"
   stack_trace:
     dependency: transitive
     description:
@@ -172,10 +185,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: eb6ac1540b26de412b3403a163d919ba86f6a973fe6cc50ae3541b80092fdcfb
+      sha256: daadc9baabec998b062c9091525aa95786508b1c48e9c30f1f891b8bf6ff2e64
       url: "https://pub.dev"
     source: hosted
-    version: "0.5.1"
+    version: "0.5.2"
   vector_math:
     dependency: transitive
     description:

pubspec.yaml

@@ -1,90 +1,24 @@
 name: instreal
-description: A new Flutter project.
-# The following line prevents the package from being accidentally published to
-# pub.dev using `flutter pub publish`. This is preferred for private packages.
-publish_to: 'none' # Remove this line if you wish to publish to pub.dev
-
-# The following defines the version and build number for your application.
-# A version number is three numbers separated by dots, like 1.2.43
-# followed by an optional build number separated by a +.
-# Both the version and the builder number may be overridden in flutter
-# build by specifying --build-name and --build-number, respectively.
-# In Android, build-name is used as versionName while build-number used as versionCode.
-# Read more about Android versioning at https://developer.android.com/studio/publish/versioning
-# In iOS, build-name is used as CFBundleShortVersionString while build-number is used as CFBundleVersion.
-# Read more about iOS versioning at
-# https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html
-# In Windows, build-name is used as the major, minor, and patch parts
-# of the product and file versions while build-number is used as the build suffix.
+description: Instreal Flutter project.
+publish_to: 'none'
 version: 1.0.0+1
 
 environment:
   sdk: ^3.0.0
 
-# Dependencies specify other packages that your package needs in order to work.
-# To automatically upgrade your package dependencies to the latest versions
-# consider running `flutter pub upgrade --major-versions`. Alternatively,
-# dependencies can be manually updated by changing the version numbers below to
-# the latest version available on pub.dev. To see which dependencies have newer
-# versions available, run `flutter pub outdated`.
 dependencies:
   flutter:
     sdk: flutter
-
-
-  # The following adds the Cupertino Icons font to your application.
-  # Use with the CupertinoIcons class for iOS style icons.
-  cupertino_icons: ^1.0.2
+  flutter_localizations:
+    sdk: flutter
+  intl: any
+  cupertino_icons: ^1.0.5
 
 dev_dependencies:
   flutter_test:
     sdk: flutter
+  flutter_lints: ^2.0.1
 
-  # The "flutter_lints" package below contains a set of recommended lints to
-  # encourage good coding practices. The lint set provided by the package is
-  # activated in the `analysis_options.yaml` file located at the root of your
-  # package. See that file for information about deactivating specific lint
-  # rules and activating additional ones.
-  flutter_lints: ^2.0.0
-
-# For information on the generic Dart part of this file, see the
-# following page: https://dart.dev/tools/pub/pubspec
-
-# The following section is specific to Flutter packages.
 flutter:
-
-  # The following line ensures that the Material Icons font is
-  # included with your application, so that you can use the icons in
-  # the material Icons class.
   uses-material-design: true
-
-  # To add assets to your application, add an assets section, like this:
-  # assets:
-  #   - images/a_dot_burr.jpeg
-  #   - images/a_dot_ham.jpeg
-
-  # An image asset can refer to one or more resolution-specific "variants", see
-  # https://flutter.dev/assets-and-images/#resolution-aware
-
-  # For details regarding adding assets from package dependencies, see
-  # https://flutter.dev/assets-and-images/#from-packages
-
-  # To add custom fonts to your application, add a fonts section here,
-  # in this "flutter" section. Each entry in this list should have a
-  # "family" key with the font family name, and a "fonts" key with a
-  # list giving the asset and other descriptors for the font. For
-  # example:
-  # fonts:
-  #   - family: Schyler
-  #     fonts:
-  #       - asset: fonts/Schyler-Regular.ttf
-  #       - asset: fonts/Schyler-Italic.ttf
-  #         style: italic
-  #   - family: Trajan Pro
-  #     fonts:
-  #       - asset: fonts/TrajanPro.ttf
-  #       - asset: fonts/TrajanPro_Bold.ttf
-  #         weight: 700
-  #
-  # For details regarding fonts from package dependencies,
-  # see https://flutter.dev/custom-fonts/#from-packages
+  generate: true

untranslated-messages.json

@@ -0,0 +1 @@
+{}