Enviroment files improvements (#35)

README.md

@@ -29,6 +29,12 @@ These components are injected in the Cubits using [get_it][get_it].
 
 ## Project Setup
 
+## Environment setup
+The environment variables are defined in the `default.env` file located in `/environments/` folder.
+You can define different environments for different environments, for example, you can have a `dev.env` for development and a `prod.env` for production.
+If you need to add a privete environment variable, you can create a `${env}.private.env` file in the environments folder and it will be ignored by git.
+
+## Firebase Setup
 To run this project, you need to config the Firebase project. 
 You can do it by executing the following command:
 

analysis_options.yaml

@@ -135,6 +135,7 @@ analyzer:
     - '**/*.gen.dart'
     - '**/*.gr.dart'
     - 'lib/generated_plugin_registrant.dart'
+    - 'lib/gen/assets.gen.dart'
     - 'lib/firebase_options_*.dart'
   errors:
     invalid_annotation_target: ignore

assets/README.md

@@ -0,0 +1 @@
+Flutter application assets are taken from the assets folder. This folder contains the assets used by the application, such as images, fonts, and other files.

environments/README.md

@@ -0,0 +1,10 @@
+Application environments are taken from the environments folder. 
+This folder contains the environment variables used by the application, such as API keys, and other files.
+
+The available environment files are:
+- default.env: The default environment variables used by the application.
+- dev.env: The development environment variables used by the application.
+- private.dev.env: The private development environment variables used by the application.
+- prod.env: The production environment variables used by the application.
+- private.prod.env: The private production environment variables used by the application.
+

fastlane/Fastfile

@@ -69,7 +69,7 @@ lane :lint_code_metrics do
   end
 
   flutter_command(command: "pub run dart_code_metrics:metrics check-unused-code lib --fatal-unused")
-  flutter_command(command: "pub run dart_code_metrics:metrics check-unused-files lib --fatal-unused")
+  flutter_command(command: "pub run dart_code_metrics:metrics check-unused-files lib --fatal-unused --exclude=lib/gen/assets.gen.dart")
 end
 
 

lib/core/common/config.dart

@@ -7,27 +7,27 @@ import 'package:flutter/foundation.dart';
 import 'package:fluttips/core/common/extension/string_extensions.dart';
 import 'package:fluttips/core/common/helper/enum_helpers.dart';
 import 'package:fluttips/core/common/helper/env_helper.dart';
-import 'package:fluttips/gen/assets.gen.dart';
 
 enum Environments {
-  development,
-  production,
+  dev,
+  prod,
 }
 
 extension EnviromentPath on Environments {
   String get fileName {
     switch (this) {
-      case Environments.development:
+      case Environments.dev:
         return 'dev';
-      case Environments.production:
+      case Environments.prod:
         return 'prod';
     }
   }
 
-  String get path => 'assets/environments/$fileName';
+  String get path => '${Config._environmentFolder}/$fileName';
 }
 
 abstract class Config {
+  static const String _environmentFolder = 'environments';
   static final num maxDatabaseIntValue = pow(2, 32) - 1;
   static const int durationAnimation = 150;
 
@@ -55,7 +55,7 @@ abstract class Config {
         Environments.values,
         const String.fromEnvironment('ENV'),
       ) ??
-      Environments.development;
+      Environments.dev;
 
   static Future<void> initialize() async {
     await _EnvConfig._setupEnv(_environment);
@@ -149,7 +149,8 @@ abstract class _EnvConfig {
 
   static Future<void> _setupEnv(Environments env) async {
     _envFileEnv
-      ..addAll(await loadEnvs(Assets.environments.env))
-      ..addAll(await loadEnvs('${env.path}.env'));
+      ..addAll(await loadEnvs('${Config._environmentFolder}/default.env'))
+      ..addAll(await loadEnvs('${env.path}.env'))
+      ..addAll(await loadEnvs('${env.path}.private.env'));
   }
 }

pubspec.yaml

@@ -70,7 +70,13 @@ flutter:
   uses-material-design: true
   assets:
     - assets/
-    - assets/environments/
+    - environments/
+
+flutter_gen:
+  assets:
+    exclude:
+      - environments/*
+      - assets/README.md
 
 flavorizr:
   flavors:

scripts/checks.sh

@@ -20,4 +20,4 @@ echo "$result"
 
 fvm flutter pub run dart_code_metrics:metrics check-unused-code lib --fatal-unused || error "Linter error"
 
-fvm flutter pub run dart_code_metrics:metrics check-unused-files lib --fatal-unused || error "Linter error"
+fvm flutter pub run dart_code_metrics:metrics check-unused-files lib --fatal-unused --exclude=lib/gen/assets.gen.dart || error "Linter error"