Merge pull request #4 from Mankeli-Software/development

Development

Author: O-Hannonen

.gitignore

@@ -12,4 +12,4 @@ coverage/
 .test_runner.dart
 
 # Android studio and IntelliJ
-.idea
+.idea

CHANGELOG.md

@@ -1,5 +1,10 @@
 # dart_define changelog
 
+## 2.0.1
+
+- feat(BREAKING CHANGE): adds ability to append gitignore with generated json config file. This can be done with `--[no-]gitignore` flag. By default, it will append to gitignore.
+- fix: fixes issues with yaml_path argument breaking other options.
+
 ## 1.0.6
 
 - feat: makes it possible to change config yaml file location

README.md

@@ -11,6 +11,7 @@
   - [Using the configuration ⚙️](#using-the-configuration-️)
   - [Configuring CI/CD pipeline ✔️](#configuring-cicd-pipeline-️)
   - [Setting up flavors 🍬](#setting-up-flavors-)
+  - [Using custom yaml path 📁](#using-custom-yaml-path-)
 
 ## Motivation 🔥
 
@@ -312,4 +313,10 @@ with the configurations. To set these up
     flutter run --dart-define-from-file=config/development.json
     ```
 
+## Using custom yaml path 📁
+
+By default, `dart_define` will look for the configurations under the
+`pubspec.yaml` file in the project root. To change this behavior,
+you can specify a new yaml file with the `--yaml_path` flag.
+
 [1]: https://itnext.io/flutter-3-7-and-a-new-way-of-defining-compile-time-variables-f63db8a4f6e2

example/.gitignore

@@ -1,44 +0,0 @@
-# Miscellaneous
-*.class
-*.log
-*.pyc
-*.swp
-.DS_Store
-.atom/
-.buildlog/
-.history
-.svn/
-migrate_working_dir/
-
-# IntelliJ related
-*.iml
-*.ipr
-*.iws
-.idea/
-
-# The .vscode folder contains launch configuration and tasks you configure in
-# VS Code which you may wish to be included in version control, so this line
-# is commented out by default.
-#.vscode/
-
-# Flutter/Dart/Pub related
-**/doc/api/
-**/ios/Flutter/.last_build_id
-.dart_tool/
-.flutter-plugins
-.flutter-plugins-dependencies
-.packages
-.pub-cache/
-.pub/
-/build/
-
-# Symbolication related
-app.*.symbols
-
-# Obfuscation related
-app.*.map.json
-
-# Android Studio will place build artifacts here
-/android/app/debug
-/android/app/profile
-/android/app/release

example/dart_define.json

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

example/pubspec.yaml

@@ -37,7 +37,8 @@ dart_define:
       required: false
     - name: BOOL_VALUE
       description: An example bool value
-      required: true
+      default: true
+      required: false
   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

lib/dart_define.gen.dart

@@ -0,0 +1,7 @@
+// This file was generated by package:dart_define, DO NOT modify or remove these comments
+class DartDefine {
+  DartDefine._();
+  
+}
+
+    

lib/src/command_runner.dart

@@ -3,7 +3,6 @@ import 'package:args/command_runner.dart';
 import 'package:cli_completion/cli_completion.dart';
 import 'package:cmd_plus/cmd_plus.dart';
 import 'package:dart_define/src/commands/commands.dart';
-import 'package:dart_define/src/extension/extension.dart';
 import 'package:dart_define/src/resource/resource.dart';
 import 'package:dart_define/src/version.gen.dart';
 import 'package:pub_updater/pub_updater.dart';
@@ -48,31 +47,31 @@ class DartDefineCommandRunner extends CompletionCommandRunner<int> {
   final Logger _logger;
   final PubUpdater _pubUpdater;
 
-  @override
-  Future<int> run(Iterable<String> args) async {
-    final cmdPlus = CmdPlus();
+  String? parseOption(Iterable<String> args, String optionName) {
+    final joinedArgs = args.join(' ');
 
-    final parser = ArgParser()
-      ..addOption(kYamlPathArg)
-      ..addFlag(
-        'help',
-        abbr: 'h',
-        negatable: false,
-        help: 'Print this usage information.',
-      );
+    final regex = RegExp(
+      '--$optionName' r'(?:=|\s+)(\S+)',
+    );
 
-    final results = parser.parse(args);
+    final match = regex.firstMatch(joinedArgs);
 
-    final yamlPath = results.getAndMaybeOverrideOriginal<String>(
-      kYamlPathArg,
-      kYamlPathArgDefault,
-    );
+    if (match != null) {
+      final value = match.group(1);
+      return value;
+    }
+
+    return null;
+  }
+
+  @override
+  Future<int> run(Iterable<String> args) async {
+    final cmdPlus = CmdPlus();
 
-    cmdPlus.logger.info('Using config file: $yamlPath');
-    cmdPlus.logger.info('Args: $args');
-    cmdPlus.logger.info('Results: $results');
-    cmdPlus.logger.info('Options: ${results.options}');
-    cmdPlus.logger.info('Args: ${results.arguments}');
+    /// As ArgParser fails on unknown options and we will specify options
+    /// from the config file, we can't use ArgParser here. Thats why
+    /// we parse the yaml path with its own function.
+    final yamlPath = parseOption(args, kYamlPathArg) ?? kYamlPathArgDefault;
 
     // Add sub commands
     addCommand(

lib/src/commands/src/generate_command.dart

@@ -28,7 +28,7 @@ class GenerateCommand extends Command<int> {
       ..addSeparator('Config overrides from $yamlPath');
 
     final readingConfig = cmdPlus.logger.progress(
-      'Reading config from pubspec.yaml',
+      'Reading config from $yamlPath',
     );
 
     final yaml = DartDefineYaml();
@@ -107,6 +107,11 @@ class GenerateCommand extends Command<int> {
         kGenerateJsonArg,
         help: 'Whether to generate the json boilerplate or not',
         defaultsTo: config.generateJson,
+      )
+      ..addFlag(
+        kGenerateGitignore,
+        help: 'Whether to append gitignore with the config json or not',
+        defaultsTo: config.generateGitignore,
       );
   }
 
@@ -140,6 +145,10 @@ class GenerateCommand extends Command<int> {
       kGenerateJsonArg,
       config.generateJson,
     );
+    final generateGitignore = argResults!.getAndMaybeOverrideOriginal<bool>(
+      kGenerateGitignore,
+      config.generateGitignore,
+    );
 
     final className = argResults!.getAndMaybeOverrideOriginal<String>(
       kClassNameArg,
@@ -217,6 +226,19 @@ class GenerateCommand extends Command<int> {
       generatingDart.complete();
     }
 
+    if (generateGitignore && generateJson) {
+      final generatingGitignore = cmdPlus.logger.progress(
+        'Generating gitignore',
+      );
+
+      GitignoreConfigurationGenerator(
+        target: File('.gitignore'),
+        jsonPath: jsonPath,
+      ).generate();
+
+      generatingGitignore.complete();
+    }
+
     return ExitCode.success.code;
   }
 }

lib/src/model/src/dart_define_configuration.dart

@@ -35,6 +35,12 @@ class DartDefineConfiguration with _$DartDefineConfiguration {
       defaultValue: kGenerateJsonArgDefault,
     )
     bool generateJson,
+    @Default(kGenerateGitignoreDefault)
+    @JsonKey(
+      name: kGenerateGitignore,
+      defaultValue: kGenerateGitignoreDefault,
+    )
+    bool generateGitignore,
     @Default(kDartPathArgDefault)
     @JsonKey(
       name: kDartPathArg,