feat: adds support for flavors

Author: O-Hannonen

CHANGELOG.md

@@ -1,5 +1,9 @@
 # dart_define changelog
 
+## 1.0.4
+
+- feat: adds support for flavors
+
 ## 1.0.3
 
 - fix: fixes issues with analyzer

README.md

@@ -61,6 +61,10 @@ When the generator is run, `dart_define` reads the values from
     ```sh
     # add the tool to dependencies
     flutter pub add --dev dart_define
+
+    # If you chooce this method, you'll have to add `pub run`
+    # in from of all of the `dart_define` commands.
+    # Eg. `pub run dart_define generate`
     ```
 
 2. Define your variables in `pubspec.yaml`
@@ -76,6 +80,18 @@ When the generator is run, `dart_define` reads the values from
         # Defaults to true
         json: true 
 
+        # OPTIONAL: The path to the json file to generate. 
+        # Defaults to dart_define.json
+        json_path: dart_define.json 
+        
+        # OPTIONAL: The path to the dart file to generate. 
+        # Defaults to lib/dart_define.gen.dart
+        dart_path: lib/dart_define.gen.dart 
+        
+        # OPTIONAL: The name of the generated class. 
+        # Defaults to DartDefine
+        class_name: DartDefine 
+
         # REQUIRED: The variables to add to the generated config files
         variables: 
 
@@ -102,6 +118,19 @@ When the generator is run, `dart_define` reads the values from
             - name: BOOL_VALUE
               description: An example bool value
               required: true
+
+        # OPTIONAL: The flavors to use within the app
+        flavors: 
+
+              # REQUIRED: The name of the flavor
+            - name: production 
+
+              # REQUIRED: The description of the flavor
+              description: The production flavor 
+            - name: staging
+              description: The staging flavor
+            - name: development
+              description: The development flavor
     ```
 
 3. Generate boilerplate
@@ -111,13 +140,6 @@ When the generator is run, `dart_define` reads the values from
     dart_define generate
     ```
 
-    OR
-
-    ```sh
-    # If you added the tool to dependencies
-    dart run dart_define generate
-    ```
-
     > *NOTE: You can override values and variables from pubspec.yaml
     > config with CLI arguments*
     >
@@ -222,4 +244,65 @@ When the generator is run, `dart_define` reads the values from
     flutter build ios --dart-define-from-file=dart_define.json
     ```
 
+## Setting up flavors 🍬
+
+`dart_define` allows you to create multiple configurations, for different
+environments or white labels of your app. This means you can easily generate
+config files for all of the environments or white labels and launch your app
+with the configurations. To set these up
+
+1. Add flavors to `dart_define` config in `pubspec.yaml`
+
+    ```yaml
+    dart_define:
+        variables: 
+            - name: APP_NAME 
+              description: The apps name
+              default: My App
+              required: false 
+            - name: APP_ID
+              description: The apps unique id
+              default: com.my.app
+              required: false
+        flavors: 
+            - name: production 
+              description: The production flavor 
+            - name: staging
+              description: The staging flavor
+            - name: development
+              description: The development flavor  
+    ```
+
+2. Generate the config file for all of your flavors
+
+    ```sh
+    dart_define generate --json_path=config/production.json --FLAVOR=production
+    dart_define generate --json_path=config/staging.json --FLAVOR=staging
+    dart_define generate --json_path=config/development.json --FLAVOR=development
+    ```
+
+3. Use the flavor in your app
+
+    ```dart
+    /// `dart_define` generates this enum based on the flavors in your configurations
+    /// You can access the current flavor used to launch the application by calling
+    /// DartDefine.flavor
+    enum Flavor {
+        /// The production flavor
+        production,
+
+        /// The staging flavor
+        staging,
+
+        /// The development flavor
+        development,
+    }
+    ```
+
+4. Run application from specific flavor
+
+    ```sh
+    flutter run --dart-define-from-file=config/development.json
+    ```
+
 [1]: https://itnext.io/flutter-3-7-and-a-new-way-of-defining-compile-time-variables-f63db8a4f6e2

example/dart_define.json

@@ -1,6 +1,7 @@
 {
   "STRING_VALUE": "hello world!",
   "INT_VALUE": 3,
-  "BOOL_VALUE": true
+  "BOOL_VALUE": true,
+  "FLAVOR": "production"
 }
 

example/lib/dart_define.gen.dart

@@ -2,6 +2,11 @@
 class DartDefine {
   DartDefine._();
 
+  /// The flavor the app was launched with
+  static Flavor get flavor => FlavorExtension.fromString(
+        const String.fromEnvironment('FLAVOR'),
+      );
+
   /// An example String value
   static const stringValue = String.fromEnvironment('STRING_VALUE');
 
@@ -11,3 +16,30 @@ class DartDefine {
   /// An example bool value
   static const boolValue = bool.fromEnvironment('BOOL_VALUE');
 }
+
+/// The flavors supported by the application
+enum Flavor {
+  /// The production flavor
+  production,
+
+  /// The staging flavor
+  staging,
+
+  /// The development flavor
+  development,
+}
+
+extension FlavorExtension on Flavor {
+  static Flavor fromString(String value) {
+    switch (value) {
+      case 'production':
+        return Flavor.production;
+      case 'staging':
+        return Flavor.staging;
+      case 'development':
+        return Flavor.development;
+      default:
+        throw throw Exception('Invalid flavor');
+    }
+  }
+}

example/pubspec.yaml

@@ -20,8 +20,12 @@ flutter:
   uses-material-design: true
 
 dart_define:
-  dart: true # Whether to generate the dart boilerplate or not. Defaults to true
-  json: true # Whether to generate the json boilerplate or not. Defaults to true
+  dart: true # OPTIONAL: Whether to generate the dart boilerplate or not. Defaults to true
+  json: true # OPTIONAL: Whether to generate the json boilerplate or not. Defaults to true
+  json_path: dart_define.json # OPTIONAL: The path to the json file to generate. Defaults to dart_define.json
+  dart_path: lib/dart_define.gen.dart # OPTIONAL: The path to the dart file to generate. Defaults to lib/dart_define.gen.dart
+  class_name: DartDefine # OPTIONAL: The name of the generated class. Defaults to DartDefine
+
   variables: # The variables to add to the generated config files
     - name: STRING_VALUE # REQUIRED: The name of the variable
       description: An example String value # REQUIRED: The description of the variable
@@ -34,3 +38,10 @@ dart_define:
     - name: BOOL_VALUE
       description: An example bool value
       required: true
+  flavors: # OPTIONAL: The flavors to use within the app
+    - name: production # REQUIRED: The name of the flavor
+      description: The production flavor # REQUIRED: The description of the flavor
+    - name: staging
+      description: The staging flavor
+    - name: development
+      description: The development flavor

lib/src/commands/src/generate_command.dart

@@ -61,12 +61,40 @@ class GenerateCommand extends Command<int> {
         variable.name,
         help:
             '${variable.required ? 'required' : 'optional'}: ${variable.description}}',
-        defaultsTo:
-            variable.required ? null : variable.defaultValue?.toString(),
+        defaultsTo: variable.defaultValue?.toString(),
         valueHelp: variable.defaultValue?.toString(),
       );
     }
 
+    final flavors = config.flavors;
+
+    if (flavors != null) {
+      if (config.variables.any((v) => v.name == kFlavorArg)) {
+        throw ArgumentError(
+          'You cannot specify a variable named "$kFlavorArg" when you have flavors in your config file. This name is reserved for the flavor argument.',
+        );
+      }
+
+      config = config.copyWith(
+        variables: [
+          ...config.variables,
+          VariableConfiguration(
+            name: kFlavorArg,
+            description: '',
+            defaultValue: flavors.first.name,
+          ),
+        ],
+      );
+
+      argParser.addOption(
+        kFlavorArg,
+        help: 'optional: Flavor to generate the code for',
+        allowed: flavors.map((e) => e.name),
+        valueHelp: flavors.first.name,
+        defaultsTo: flavors.first.name,
+      );
+    }
+
     readingConfig.complete();
   }
 

lib/src/model/model.dart

@@ -1,3 +1,4 @@
 export 'src/argument_variable.dart';
 export 'src/dart_define_configuration.dart';
+export 'src/flavor_configuration.dart';
 export 'src/variable_configuration.dart';

lib/src/model/src/dart_define_configuration.dart

@@ -28,37 +28,41 @@ class DartDefineConfiguration with _$DartDefineConfiguration {
       name: kGenerateDartArg,
       defaultValue: kGenerateDartArgDefault,
     )
-        bool generateDart,
+    bool generateDart,
     @Default(kGenerateJsonArgDefault)
     @JsonKey(
       name: kGenerateJsonArg,
       defaultValue: kGenerateJsonArgDefault,
     )
-        bool generateJson,
+    bool generateJson,
     @Default(kDartPathArgDefault)
     @JsonKey(
       name: kDartPathArg,
       defaultValue: kDartPathArgDefault,
     )
-        String dartPath,
+    String dartPath,
     @Default(kJsonPathArgDefault)
     @JsonKey(
       name: kJsonPathArg,
       defaultValue: kJsonPathArgDefault,
     )
-        String jsonPath,
+    String jsonPath,
     @Default(kClassNameArgDefault)
     @JsonKey(
       name: kClassNameArg,
       defaultValue: kClassNameArgDefault,
     )
-        String className,
+    String className,
     @Default([])
     @JsonKey(
       name: kVariablesKey,
       defaultValue: [],
     )
-        List<VariableConfiguration> variables,
+    List<VariableConfiguration> variables,
+    @JsonKey(
+      name: kFlavorsKey,
+    )
+    List<FlavorConfiguration>? flavors,
   }) = _DartDefineConfiguration;
 
   const DartDefineConfiguration._();