refactor(app): Обновить описание и структуру файлов конфигурации, улучшить документацию (#14)

Co-authored-by: PetrovY <y.petrov@friflex.com>

lib/app/app_config/app_config.dart

@@ -1,12 +1,45 @@
 import 'package:envied/envied.dart';
-import 'package:friflex_starter/app/app_config/i_app_config.dart';
 import 'package:friflex_starter/app/app_env.dart';
 
 part 'app_config.g.dart';
 
-/// Класс для реализации конфигурации с моковыми данными
+/// {@template i_app_config}
+/// Интерфейс для конфигурации приложения.
+///
+/// Определяет обязательные параметры для всех реализаций конфигурации:
+/// - Наименование конфигурации
+/// - Базовый URL для API
+/// - Тип окружения (dev, prod, stage)
+/// - Секретный ключ для шифрования данных
+/// {@endtemplate}
+abstract interface class IAppConfig {
+  /// {@macro i_app_config}
+  IAppConfig();
+
+  /// Наименование сервиса конфигурации
+  String get name => 'IAppConfig';
+
+  /// Основной адрес для запросов к API
+  String get baseUrl;
+
+  /// Тип окружения (dev, prod, stage)
+  AppEnv get env;
+
+  /// Секретный ключ для шифрования данных
+  String get secretKey;
+}
+
+/// {@template app_config_dev}
+/// Класс для реализации конфигурации приложения в режиме разработки.
+///
+/// Использует переменные окружения из файла env/dev.env.
+/// Предназначен для локальной разработки и тестирования.
+/// {@endtemplate}
 @Envied(name: 'Dev', path: 'env/dev.env')
 class AppConfigDev implements IAppConfig {
+  /// {@macro app_config_dev}
+  AppConfigDev();
+
   @override
   AppEnv get env => AppEnv.dev;
 
@@ -22,9 +55,17 @@ class AppConfigDev implements IAppConfig {
   final String secretKey = _Dev.secretKey;
 }
 
-/// Класс для реализации конфигурации с продакшн данными
+/// {@template app_config_prod}
+/// Класс для реализации конфигурации приложения в продакшн режиме.
+///
+/// Использует переменные окружения из файла env/prod.env.
+/// Предназначен для финальной сборки приложения.
+/// {@endtemplate}
 @Envied(name: 'Prod', path: 'env/prod.env')
 class AppConfigProd implements IAppConfig {
+  /// {@macro app_config_prod}
+  AppConfigProd();
+
   @override
   AppEnv get env => AppEnv.prod;
 
@@ -40,9 +81,17 @@ class AppConfigProd implements IAppConfig {
   final String secretKey = _Prod.secretKey;
 }
 
-/// Класс для реализации конфигурации с стейдж данными
+/// {@template app_config_stage}
+/// Класс для реализации конфигурации приложения в стейдж режиме.
+///
+/// Использует переменные окружения из файла env/stage.env.
+/// Предназначен для тестирования в среде, близкой к продакшн.
+/// {@endtemplate}
 @Envied(name: 'Stage', path: 'env/stage.env')
 class AppConfigStage implements IAppConfig {
+  /// {@macro app_config_stage}
+  AppConfigStage();
+
   @override
   AppEnv get env => AppEnv.stage;
 

lib/app/app_config/app_config.g.dart

@@ -24,11 +24,13 @@ final class _Dev {
     4081271699,
   ];
 
-  static final String secretKey = String.fromCharCodes(List<int>.generate(
-    _envieddatasecretKey.length,
-    (int i) => i,
-    growable: false,
-  ).map((int i) => _envieddatasecretKey[i] ^ _enviedkeysecretKey[i]));
+  static final String secretKey = String.fromCharCodes(
+    List<int>.generate(
+      _envieddatasecretKey.length,
+      (int i) => i,
+      growable: false,
+    ).map((int i) => _envieddatasecretKey[i] ^ _enviedkeysecretKey[i]),
+  );
 }
 
 // coverage:ignore-file
@@ -65,11 +67,13 @@ final class _Prod {
     655048645,
   ];
 
-  static final String baseUrl = String.fromCharCodes(List<int>.generate(
-    _envieddatabaseUrl.length,
-    (int i) => i,
-    growable: false,
-  ).map((int i) => _envieddatabaseUrl[i] ^ _enviedkeybaseUrl[i]));
+  static final String baseUrl = String.fromCharCodes(
+    List<int>.generate(
+      _envieddatabaseUrl.length,
+      (int i) => i,
+      growable: false,
+    ).map((int i) => _envieddatabaseUrl[i] ^ _enviedkeybaseUrl[i]),
+  );
 
   static const List<int> _enviedkeysecretKey = <int>[
     359753139,
@@ -85,11 +89,13 @@ final class _Prod {
     3044498279,
   ];
 
-  static final String secretKey = String.fromCharCodes(List<int>.generate(
-    _envieddatasecretKey.length,
-    (int i) => i,
-    growable: false,
-  ).map((int i) => _envieddatasecretKey[i] ^ _enviedkeysecretKey[i]));
+  static final String secretKey = String.fromCharCodes(
+    List<int>.generate(
+      _envieddatasecretKey.length,
+      (int i) => i,
+      growable: false,
+    ).map((int i) => _envieddatasecretKey[i] ^ _enviedkeysecretKey[i]),
+  );
 }
 
 // coverage:ignore-file
@@ -128,11 +134,13 @@ final class _Stage {
     568662398,
   ];
 
-  static final String baseUrl = String.fromCharCodes(List<int>.generate(
-    _envieddatabaseUrl.length,
-    (int i) => i,
-    growable: false,
-  ).map((int i) => _envieddatabaseUrl[i] ^ _enviedkeybaseUrl[i]));
+  static final String baseUrl = String.fromCharCodes(
+    List<int>.generate(
+      _envieddatabaseUrl.length,
+      (int i) => i,
+      growable: false,
+    ).map((int i) => _envieddatabaseUrl[i] ^ _enviedkeybaseUrl[i]),
+  );
 
   static const List<int> _enviedkeysecretKey = <int>[
     2132342089,
@@ -150,9 +158,11 @@ final class _Stage {
     1192880631,
   ];
 
-  static final String secretKey = String.fromCharCodes(List<int>.generate(
-    _envieddatasecretKey.length,
-    (int i) => i,
-    growable: false,
-  ).map((int i) => _envieddatasecretKey[i] ^ _enviedkeysecretKey[i]));
+  static final String secretKey = String.fromCharCodes(
+    List<int>.generate(
+      _envieddatasecretKey.length,
+      (int i) => i,
+      growable: false,
+    ).map((int i) => _envieddatasecretKey[i] ^ _enviedkeysecretKey[i]),
+  );
 }

lib/app/app_config/i_app_config.dart

@@ -1,16 +1,2 @@
 import 'package:friflex_starter/app/app_env.dart';
 
-/// Класс для описания интерфейса конфигурации
-abstract interface class IAppConfig {
-  /// Наименование сервиса
-  String get name => 'IAppConfig';
-
-  /// Основной адрес для запросов к API
-  String get baseUrl;
-
-  /// Тип окружения
-  AppEnv get env;
-
-  /// Секретный ключ для шифрования данных
-  String get secretKey;
-}