feat(create): add create config to very_good.yaml (#1665)

* feat(create): add create config to very_good.yaml

Add a `create` section to `very_good.yaml` so `very_good create` and its
subcommands can read defaults for `description`, `org_name`, `publishable`,
and `template`. CLI arguments continue to take precedence over config values.

Closes #1654

* fix: tests

* style: format create_subcommand.dart

* fix: tests

* fix: ci issues

* refactor: move config load to VeryGoodConfig

* chore: review

* fix(create): remove unused workspaceSubcommandNames getter

The getter was never referenced, breaking the 100% coverage gate.

---------

Co-authored-by: unicoderbot[bot] <269805761+unicoderbot[bot]@users.noreply.github.com>
Co-authored-by: marcossevilla <marcossevilla@users.noreply.github.com>

Author: marcossevilla

.github/workflows/e2e.yaml

@@ -43,6 +43,7 @@ jobs:
           - test/commands/create/flame_game/flame_game_test.dart
           - test/commands/create/flutter_package/flutter_pkg_test.dart
           - test/commands/create/flutter_plugin/flutter_plugin_test.dart
+          - test/commands/create/very_good_config/very_good_config_test.dart
 
           # E2E tests for the `packages check licenses` command
           - test/commands/packages/check/licenses/licenses_allowed_test.dart

e2e/test/commands/create/very_good_config/fixture/very_good.yaml

@@ -0,0 +1,3 @@
+create:
+  description: A project configured via very_good.yaml.
+  publishable: true

e2e/test/commands/create/very_good_config/malformed_fixture/very_good.yaml

@@ -0,0 +1,3 @@
+- not
+- a
+- map

e2e/test/commands/create/very_good_config/very_good_config_test.dart

@@ -0,0 +1,85 @@
+import 'package:mason/mason.dart';
+import 'package:mocktail/mocktail.dart';
+import 'package:path/path.dart' as path;
+import 'package:test/test.dart';
+import 'package:universal_io/io.dart';
+
+import '../../../../helpers/helpers.dart';
+
+void main() {
+  group('very_good.yaml', () {
+    test(
+      'applies create defaults from very_good.yaml when flags are not passed',
+      timeout: const Timeout(Duration(minutes: 2)),
+      withRunner((commandRunner, logger, updater, logs, progressLogs) async {
+        final tempDirectory = Directory.systemTemp.createTempSync(
+          'very_good_config_create',
+        );
+        addTearDown(() => tempDirectory.deleteSync(recursive: true));
+
+        final fixture = Directory(
+          path.join(
+            Directory.current.path,
+            'test/commands/create/very_good_config/fixture',
+          ),
+        );
+
+        await copyDirectory(fixture, tempDirectory);
+
+        final cwd = Directory.current;
+        Directory.current = tempDirectory;
+        addTearDown(() => Directory.current = cwd);
+
+        final result = await commandRunner.run([
+          'create',
+          'dart_package',
+          'very_good_dart',
+        ]);
+        expect(result, equals(ExitCode.success.code));
+
+        final pubspec = File(
+          path.join(tempDirectory.path, 'very_good_dart', 'pubspec.yaml'),
+        );
+        expect(pubspec.existsSync(), isTrue);
+        expect(
+          pubspec.readAsStringSync(),
+          contains('A project configured via very_good.yaml.'),
+        );
+      }),
+    );
+
+    test(
+      'fails with config exit code when very_good.yaml is malformed',
+      timeout: const Timeout(Duration(minutes: 2)),
+      withRunner((commandRunner, logger, updater, logs, progressLogs) async {
+        final tempDirectory = Directory.systemTemp.createTempSync(
+          'very_good_config_create_malformed',
+        );
+        addTearDown(() => tempDirectory.deleteSync(recursive: true));
+
+        final fixture = Directory(
+          path.join(
+            Directory.current.path,
+            'test/commands/create/very_good_config/malformed_fixture',
+          ),
+        );
+
+        await copyDirectory(fixture, tempDirectory);
+
+        final cwd = Directory.current;
+        Directory.current = tempDirectory;
+        addTearDown(() => Directory.current = cwd);
+
+        await expectLater(
+          commandRunner.run(['create', 'dart_package', 'very_good_dart']),
+          completion(equals(ExitCode.config.code)),
+        );
+        verify(
+          () => logger.err(
+            any(that: contains('Could not read `very_good.yaml`')),
+          ),
+        ).called(1);
+      }),
+    );
+  });
+}

lib/src/commands/create/commands/create_subcommand.dart

@@ -8,6 +8,7 @@ import 'package:meta/meta.dart';
 import 'package:path/path.dart' as path;
 import 'package:very_good_cli/src/commands/commands.dart';
 import 'package:very_good_cli/src/commands/create/templates/templates.dart';
+import 'package:very_good_cli/src/very_good_config/very_good_config.dart';
 
 // A valid Dart identifier that can be used for a package, i.e. no
 // capital letters.
@@ -118,6 +119,14 @@ abstract class CreateSubCommand extends Command<int> {
   final Logger logger;
   final MasonGeneratorFromBundle _generatorFromBundle;
 
+  /// The resolved `very_good create` configuration read from the closest
+  /// `very_good.yaml` file.
+  ///
+  /// Values declared here are used as defaults for any option that was not
+  /// explicitly passed on the command line. It defaults to an empty
+  /// configuration until [run] loads it.
+  VeryGoodCreateConfig createConfig = const VeryGoodCreateConfig();
+
   /// [ArgResults] which can be overridden for testing.
   @visibleForTesting
   ArgResults? argResultOverrides;
@@ -174,7 +183,11 @@ abstract class CreateSubCommand extends Command<int> {
   }
 
   /// Gets the description for the project.
-  String get projectDescription => argResults['description'] as String? ?? '';
+  String get projectDescription => argResults.resolve<String>(
+    'description',
+    createConfig.description,
+    fallbackValue: '',
+  );
 
   /// Should return the desired template to be created during a command run.
   ///
@@ -194,6 +207,10 @@ abstract class CreateSubCommand extends Command<int> {
 
   @override
   Future<int> run() async {
+    final config = VeryGoodConfig.load(Directory.current, logger: logger);
+    if (config == null) return ExitCode.config.code;
+    createConfig = config.create;
+
     final template = this.template;
     final bundle = template.bundle;
 
@@ -273,7 +290,11 @@ abstract class CreateSubCommand extends Command<int> {
 mixin OrgName on CreateSubCommand {
   /// Gets the organization name.
   String get orgName {
-    final orgName = argResults['org-name'] as String? ?? _defaultOrgName;
+    final orgName = argResults.resolve<String>(
+      'org-name',
+      createConfig.orgName,
+      fallbackValue: _defaultOrgName,
+    );
     _validateOrgName(orgName);
     return orgName;
   }
@@ -317,10 +338,26 @@ mixin MultiTemplates on CreateSubCommand {
   @nonVirtual
   @override
   Template get template {
-    final templateName =
-        argResults['template'] as String? ?? defaultTemplateName;
+    final templateName = argResults.resolve<String>(
+      'template',
+      createConfig.template,
+      fallbackValue: defaultTemplateName,
+    );
 
-    return templates.firstWhere((template) => template.name == templateName);
+    return templates.firstWhere(
+      (template) => template.name == templateName,
+      orElse: () {
+        // When the value came from `very_good.yaml` rather than the command
+        // line, point the user at the config key instead of the CLI option so
+        // they debug the right place.
+        final source = argResults.wasParsed('template')
+            ? 'option "--template"'
+            : 'the `create.template` key in `$veryGoodConfigFileName`';
+        usageException(
+          '"$templateName" is not an allowed value for $source.',
+        );
+      },
+    );
   }
 }
 
@@ -331,7 +368,11 @@ mixin MultiTemplates on CreateSubCommand {
 /// to the brick generator.
 mixin Publishable on CreateSubCommand {
   /// Gets the publishable flag.
-  bool get publishable => argResults['publishable'] as bool? ?? false;
+  bool get publishable => argResults.resolve<bool>(
+    'publishable',
+    createConfig.publishable,
+    fallbackValue: false,
+  );
 }
 
 /// Mixin for [CreateSubCommand] subclasses that receives the workspace flag.
@@ -340,5 +381,9 @@ mixin Publishable on CreateSubCommand {
 /// to the brick generator.
 mixin Workspace on CreateSubCommand {
   /// Gets the workspace flag.
-  bool get workspace => argResults['workspace'] as bool? ?? false;
+  bool get workspace => argResults.resolve<bool>(
+    'workspace',
+    createConfig.workspace,
+    fallbackValue: false,
+  );
 }

lib/src/commands/create/commands/docs_site.dart

@@ -1,5 +1,6 @@
 import 'package:very_good_cli/src/commands/commands.dart';
 import 'package:very_good_cli/src/commands/create/templates/templates.dart';
+import 'package:very_good_cli/src/very_good_config/very_good_config.dart';
 
 /// {@template very_good_create_docs_site}
 /// A [CreateSubCommand] for creating Dart command line interfaces.
@@ -30,7 +31,11 @@ class CreateDocsSite extends CreateSubCommand with Publishable {
   Map<String, dynamic> getTemplateVars() {
     return <String, dynamic>{
       ...super.getTemplateVars(),
-      'org_name': argResults['org-name'],
+      'org_name': argResults.resolve<String>(
+        'org-name',
+        createConfig.orgName,
+        fallbackValue: _defaultOrgName,
+      ),
     };
   }
 

lib/src/commands/dart/commands/dart_test_command.dart

@@ -283,7 +283,7 @@ class DartTestCommand extends Command<int> {
         help:
             'Whether to collect coverage from imported files only or all '
             'files.',
-        allowed: ['imports', 'all'],
+        allowed: collectCoverageFromAllowedValues,
         defaultsTo: 'imports',
         valueHelp: 'imports|all',
       )
@@ -369,16 +369,8 @@ This command should be run from the root of your Dart project.''');
       return ExitCode.noInput.code;
     }
 
-    final VeryGoodConfig config;
-    try {
-      config = VeryGoodConfig.loadFromClosestAncestor(Directory(targetPath));
-    } on VeryGoodConfigParseException catch (e) {
-      _logger.err(
-        'Could not read `$veryGoodConfigFileName`.\n'
-        '${e.message}',
-      );
-      return ExitCode.config.code;
-    }
+    final config = VeryGoodConfig.load(Directory(targetPath), logger: _logger);
+    if (config == null) return ExitCode.config.code;
 
     final isDartInstalled = await _dartInstalled(logger: _logger);
 

lib/src/commands/packages/commands/check/commands/licenses.dart

@@ -157,12 +157,7 @@ class PackagesCheckLicensesCommand extends Command<int> {
       ..addMultiOption(
         'dependency-type',
         help: 'The type of dependencies to check licenses for.',
-        allowed: [
-          'direct-main',
-          'direct-dev',
-          'direct-overridden',
-          'transitive',
-        ],
+        allowed: dependencyTypeAllowedValues,
         allowedHelp: {
           'direct-main': 'Check for direct main dependencies.',
           'direct-dev': 'Check for direct dev dependencies.',
@@ -183,7 +178,7 @@ class PackagesCheckLicensesCommand extends Command<int> {
       ..addOption(
         'reporter',
         help: 'Lists all licenses.',
-        allowed: ['text', 'csv'],
+        allowed: reporterAllowedValues,
         allowedHelp: {
           'text': 'Lists licenses without a specific format.',
           'csv': 'Lists licenses in a CSV format.',
@@ -211,16 +206,8 @@ class PackagesCheckLicensesCommand extends Command<int> {
     final target = _argResults.rest.length == 1 ? _argResults.rest[0] : '.';
     final targetPath = path.normalize(Directory(target).absolute.path);
 
-    final VeryGoodConfig config;
-    try {
-      config = VeryGoodConfig.loadFromClosestAncestor(Directory(targetPath));
-    } on VeryGoodConfigParseException catch (e) {
-      _logger.err(
-        'Could not read `$veryGoodConfigFileName`.\n'
-        '${e.message}',
-      );
-      return ExitCode.config.code;
-    }
+    final config = VeryGoodConfig.load(Directory(targetPath), logger: _logger);
+    if (config == null) return ExitCode.config.code;
 
     final options = PackagesCheckLicensesOptions.parse(
       _argResults,

lib/src/commands/packages/commands/get.dart

@@ -85,16 +85,8 @@ class PackagesGetCommand extends Command<int> {
     final target = _argResults.rest.length == 1 ? _argResults.rest[0] : '.';
     final targetPath = path.normalize(Directory(target).absolute.path);
 
-    final VeryGoodConfig config;
-    try {
-      config = VeryGoodConfig.loadFromClosestAncestor(Directory(targetPath));
-    } on VeryGoodConfigParseException catch (e) {
-      _logger.err(
-        'Could not read `$veryGoodConfigFileName`.\n'
-        '${e.message}',
-      );
-      return ExitCode.config.code;
-    }
+    final config = VeryGoodConfig.load(Directory(targetPath), logger: _logger);
+    if (config == null) return ExitCode.config.code;
 
     final options = PackagesGetOptions.parse(_argResults, config: config);
 

lib/src/commands/test/test.dart

@@ -333,7 +333,7 @@ class TestCommand extends Command<int> {
         help:
             'Whether to collect coverage from imported files only or all '
             'files.',
-        allowed: ['imports', 'all'],
+        allowed: collectCoverageFromAllowedValues,
         defaultsTo: 'imports',
         valueHelp: 'imports|all',
       )
@@ -458,16 +458,8 @@ This command should be run from the root of your Flutter project.''');
       return ExitCode.noInput.code;
     }
 
-    final VeryGoodConfig config;
-    try {
-      config = VeryGoodConfig.loadFromClosestAncestor(Directory(targetPath));
-    } on VeryGoodConfigParseException catch (e) {
-      _logger.err(
-        'Could not read `$veryGoodConfigFileName`.\n'
-        '${e.message}',
-      );
-      return ExitCode.config.code;
-    }
+    final config = VeryGoodConfig.load(Directory(targetPath), logger: _logger);
+    if (config == null) return ExitCode.config.code;
 
     final isFlutterInstalled = await _flutterInstalled(logger: _logger);