Skip to content

Commit b8a4d65

Browse files
committed
docs(config): clarify single-platform build requirements in AppConfig
- Add detailed explanation for handling single-platform builds - Provide guidance on using dummy values for unused platform keys - Emphasize that dummy values must not contain the "YOUR_" prefix - Clarify that dummy values will not be used in the target platform build
1 parent 06c94ac commit b8a4d65

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

lib/app/config/app_config.dart

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,17 @@ import 'dart:io' show Platform;
2929
/// - A required key is missing.
3030
/// - A key still contains a placeholder value (e.g., 'YOUR_DEV_...').
3131
/// This prevents runtime errors and ensures a correctly configured build.
32+
///
33+
/// ## Handling Single-Platform Builds
34+
/// The validation logic requires that all platform-specific keys (for both
35+
/// Android and iOS) are provided. If you are developing for a single platform
36+
/// (e.g., only Android), you must still provide non-placeholder values for the
37+
/// other platform's keys to satisfy the validator.
38+
///
39+
/// For any unused platform keys, you can provide a simple dummy string like
40+
/// `"unused-ios-key"`. As long as the value does not contain the "YOUR_"
41+
/// prefix, the validation will pass. These dummy values will not be used when
42+
/// building for your target platform.
3243
/// {@endtemplate}
3344
class AppConfig {
3445
/// {@macro app_config}

0 commit comments

Comments
 (0)